diff --git a/docs/assets/images/favicon.png b/docs/assets/images/favicon.png deleted file mode 100644 index ee5a9f9..0000000 Binary files a/docs/assets/images/favicon.png and /dev/null differ diff --git a/docs/classes/apicallmodel.html b/docs/classes/apicallmodel.html index 59e5108..3b506ab 100644 --- a/docs/classes/apicallmodel.html +++ b/docs/classes/apicallmodel.html @@ -104,7 +104,7 @@
config: ApiCallConfig<TResult, TInput>
diff --git a/docs/classes/datacache.html b/docs/classes/datacache.html index a02b60c..91a3efc 100644 --- a/docs/classes/datacache.html +++ b/docs/classes/datacache.html @@ -123,7 +123,7 @@
  • Parameters

    @@ -145,7 +145,7 @@
    getter: function
    @@ -187,7 +187,7 @@
    obj: number
    @@ -197,7 +197,7 @@
    time: function | number
    @@ -214,7 +214,7 @@
  • @@ -245,7 +245,7 @@
  • @@ -267,7 +267,7 @@
  • Returns void

    @@ -284,7 +284,7 @@
  • @@ -339,7 +339,7 @@
  • diff --git a/docs/classes/datastoreservice.html b/docs/classes/datastoreservice.html index 328b49d..0588c1b 100644 --- a/docs/classes/datastoreservice.html +++ b/docs/classes/datastoreservice.html @@ -106,7 +106,7 @@
  • Parameters

    @@ -132,7 +132,7 @@
  • Parameters

    @@ -164,7 +164,7 @@
  • Type parameters

    @@ -202,7 +202,7 @@
  • Type parameters

    @@ -243,7 +243,7 @@
  • Type parameters

    diff --git a/docs/classes/datatransformersservice.html b/docs/classes/datatransformersservice.html index 5d25c76..b578114 100644 --- a/docs/classes/datatransformersservice.html +++ b/docs/classes/datatransformersservice.html @@ -98,7 +98,7 @@
  • Parameters

    @@ -124,7 +124,7 @@
  • Parameters

    diff --git a/docs/classes/entitiesservice.html b/docs/classes/entitiesservice.html index a4026d1..6ad7294 100644 --- a/docs/classes/entitiesservice.html +++ b/docs/classes/entitiesservice.html @@ -111,7 +111,7 @@

    Returns Array<ModelEntity>

    @@ -132,7 +132,7 @@

    Parameters

    @@ -159,7 +159,7 @@

    Parameters

    @@ -183,7 +183,7 @@

    Parameters

    diff --git a/docs/classes/entitiesservicebase.html b/docs/classes/entitiesservicebase.html index 7913185..c8bfe2e 100644 --- a/docs/classes/entitiesservicebase.html +++ b/docs/classes/entitiesservicebase.html @@ -121,7 +121,7 @@
  • Returns Array<T>

    @@ -141,7 +141,7 @@
  • Parameters

    @@ -167,7 +167,7 @@
  • Parameters

    @@ -190,7 +190,7 @@
  • Parameters

    diff --git a/docs/classes/entityconfigbase.html b/docs/classes/entityconfigbase.html index bba91e8..62c6967 100644 --- a/docs/classes/entityconfigbase.html +++ b/docs/classes/entityconfigbase.html @@ -147,7 +147,7 @@
  • Parameters

    @@ -173,7 +173,7 @@ @@ -184,7 +184,7 @@ @@ -195,7 +195,7 @@ @@ -206,7 +206,7 @@ @@ -217,7 +217,7 @@ @@ -228,7 +228,7 @@
    @@ -272,7 +272,7 @@ @@ -283,7 +283,7 @@ @@ -300,7 +300,7 @@
  • Returns Array<Field>

    @@ -320,7 +320,7 @@
  • Returns TEntity

    @@ -337,7 +337,7 @@
  • Parameters

    @@ -360,7 +360,7 @@
  • Parameters

    @@ -383,7 +383,7 @@
  • Parameters

    diff --git a/docs/classes/entityfieldsservice.html b/docs/classes/entityfieldsservice.html index 733a402..22861b8 100644 --- a/docs/classes/entityfieldsservice.html +++ b/docs/classes/entityfieldsservice.html @@ -98,7 +98,7 @@
  • Parameters

    @@ -124,7 +124,7 @@
  • Parameters

    diff --git a/docs/classes/entitymodelbase.html b/docs/classes/entitymodelbase.html index fdf9d7c..cccafc5 100644 --- a/docs/classes/entitymodelbase.html +++ b/docs/classes/entitymodelbase.html @@ -126,7 +126,7 @@

    Parameters

    @@ -149,7 +149,7 @@ @@ -160,7 +160,7 @@ diff --git a/docs/classes/entityrelationshipsservice.html b/docs/classes/entityrelationshipsservice.html index ed7223e..ea24154 100644 --- a/docs/classes/entityrelationshipsservice.html +++ b/docs/classes/entityrelationshipsservice.html @@ -98,7 +98,7 @@
  • Parameters

    @@ -121,7 +121,7 @@
  • Parameters

    diff --git a/docs/classes/errorsservice.html b/docs/classes/errorsservice.html index 05ded39..e497d15 100644 --- a/docs/classes/errorsservice.html +++ b/docs/classes/errorsservice.html @@ -97,7 +97,7 @@
  • Parameters

    diff --git a/docs/classes/http.html b/docs/classes/http.html index 53994e0..4309dcf 100644 --- a/docs/classes/http.html +++ b/docs/classes/http.html @@ -105,7 +105,7 @@
  • Parameters

    @@ -134,7 +134,7 @@
  • Parameters

    @@ -163,7 +163,7 @@
  • Parameters

    @@ -192,7 +192,7 @@
  • Parameters

    @@ -218,7 +218,7 @@
  • Parameters

    @@ -244,7 +244,7 @@
  • Parameters

    @@ -273,7 +273,7 @@
  • Parameters

    @@ -302,7 +302,7 @@
  • Parameters

    @@ -331,7 +331,7 @@
  • Type parameters

    diff --git a/docs/classes/immutability.html b/docs/classes/immutability.html index 9574a40..db19d21 100644 --- a/docs/classes/immutability.html +++ b/docs/classes/immutability.html @@ -98,7 +98,7 @@
  • @@ -141,7 +141,7 @@
  • Type parameters

    diff --git a/docs/classes/modelbase.html b/docs/classes/modelbase.html index cc5fc89..7701310 100644 --- a/docs/classes/modelbase.html +++ b/docs/classes/modelbase.html @@ -117,7 +117,7 @@
  • Parameters

    @@ -139,7 +139,7 @@
    $parent: ModelBase
    @@ -149,7 +149,7 @@
    id: any
    diff --git a/docs/classes/modelentity.html b/docs/classes/modelentity.html index 5e16ace..5032807 100644 --- a/docs/classes/modelentity.html +++ b/docs/classes/modelentity.html @@ -164,7 +164,7 @@

    Parameters

    @@ -190,7 +190,7 @@ @@ -201,7 +201,7 @@ @@ -212,7 +212,7 @@ @@ -223,7 +223,7 @@ @@ -234,7 +234,7 @@ @@ -245,7 +245,7 @@ @@ -257,7 +257,7 @@

    Implementation of EntityConfig.entityConstructor

    Inherited from EntityConfigBase.entityConstructor

    @@ -269,7 +269,7 @@

    Implementation of EntityConfig.fields

    Inherited from EntityConfigBase.fields

    @@ -280,7 +280,7 @@
    @@ -313,7 +313,7 @@

    Implementation of EntityConfig.idProperty

    Inherited from EntityConfigBase.idProperty

    @@ -324,7 +324,7 @@ @@ -335,7 +335,7 @@
    @@ -372,7 +372,7 @@
    @@ -418,7 +418,7 @@
    @@ -456,7 +456,7 @@
    @@ -495,7 +495,7 @@

    Implementation of EntityConfig.pluralName

    Inherited from EntityConfigBase.pluralName

    @@ -507,7 +507,7 @@

    Implementation of EntityConfig.readonly

    Inherited from EntityConfigBase.readonly

    @@ -519,7 +519,7 @@

    Implementation of EntityConfig.serializeItem

    Overrides EntityConfigBase.serializeItem

    @@ -564,7 +564,7 @@

    Implementation of EntityConfig.singularName

    Inherited from EntityConfigBase.singularName

    @@ -576,7 +576,7 @@

    Implementation of EntityConfig.values

    Inherited from EntityConfigBase.values

    @@ -594,7 +594,7 @@

    Returns Array<Field>

    @@ -615,7 +615,7 @@

    Returns TEntity

    @@ -633,7 +633,7 @@

    Parameters

    @@ -657,7 +657,7 @@

    Parameters

    @@ -681,7 +681,7 @@

    Parameters

    diff --git a/docs/classes/paris.html b/docs/classes/paris.html index dbd2f50..127bfa5 100644 --- a/docs/classes/paris.html +++ b/docs/classes/paris.html @@ -123,7 +123,7 @@
  • Parameters

    @@ -145,7 +145,7 @@
    config: ParisConfig
    @@ -155,7 +155,7 @@
    dataStore: DataStoreService
    @@ -165,7 +165,7 @@
    error$: Observable<EntityErrorEvent>
    @@ -181,7 +181,7 @@
    remove$: Observable<RemoveEntitiesEvent>
    @@ -196,7 +196,7 @@
    save$: Observable<SaveEntityEvent>
    @@ -218,7 +218,7 @@
  • @@ -271,7 +271,7 @@
  • @@ -314,7 +314,7 @@
  • @@ -366,7 +366,7 @@
  • @@ -421,7 +421,7 @@
  • @@ -451,7 +451,7 @@
  • @@ -508,7 +508,7 @@
  • @@ -548,7 +548,7 @@
  • @@ -588,7 +588,7 @@
  • @@ -633,7 +633,7 @@
  • @@ -683,7 +683,7 @@
  • diff --git a/docs/classes/readonlyrepository.html b/docs/classes/readonlyrepository.html index 90902ba..549f801 100644 --- a/docs/classes/readonlyrepository.html +++ b/docs/classes/readonlyrepository.html @@ -163,7 +163,7 @@
  • Parameters

    @@ -201,7 +201,7 @@ @@ -211,7 +211,7 @@
    entityBackendConfig: EntityBackendConfig<TEntity, TRawData>
    @@ -221,7 +221,7 @@
    entityConstructor: DataEntityConstructor<TEntity>
    @@ -231,7 +231,7 @@
    error$: Observable<EntityErrorEvent>
    @@ -248,7 +248,7 @@
  • @@ -271,7 +271,7 @@
  • @@ -296,7 +296,7 @@
  • @@ -318,7 +318,7 @@
  • @@ -340,7 +340,7 @@
  • @@ -378,7 +378,7 @@
  • @@ -401,7 +401,7 @@
  • @@ -429,7 +429,7 @@
  • @@ -468,7 +468,7 @@
  • @@ -512,7 +512,7 @@
  • @@ -544,7 +544,7 @@
  • @@ -575,7 +575,7 @@
  • @@ -629,7 +629,7 @@
  • @@ -672,7 +672,7 @@
  • diff --git a/docs/classes/relationshiprepository.html b/docs/classes/relationshiprepository.html index 824f1dd..5b55907 100644 --- a/docs/classes/relationshiprepository.html +++ b/docs/classes/relationshiprepository.html @@ -166,7 +166,7 @@

    Parameters

    @@ -204,7 +204,7 @@ @@ -215,7 +215,7 @@ @@ -227,7 +227,7 @@

    Implementation of IRelationshipRepository.entity

    Inherited from ReadonlyRepository.entity

    @@ -238,7 +238,7 @@ @@ -249,7 +249,7 @@ @@ -260,7 +260,7 @@ @@ -271,7 +271,7 @@ @@ -282,7 +282,7 @@ @@ -292,7 +292,7 @@
    sourceItem: TSource
    @@ -310,7 +310,7 @@
  • Parameters

    @@ -566,7 +566,7 @@
  • @@ -602,7 +602,7 @@

    Parameters

    @@ -628,7 +628,7 @@
  • Parameters

    @@ -657,7 +657,7 @@
  • @@ -693,7 +693,7 @@

    Parameters

    @@ -720,7 +720,7 @@
    @@ -752,7 +752,7 @@
    @@ -807,7 +807,7 @@
    @@ -851,7 +851,7 @@
    diff --git a/docs/classes/repository.html b/docs/classes/repository.html index 350eb94..4d0b9c5 100644 --- a/docs/classes/repository.html +++ b/docs/classes/repository.html @@ -160,7 +160,7 @@

    Parameters

    @@ -196,7 +196,7 @@

    Implementation of IRepository.entity

    Inherited from ReadonlyRepository.entity

    @@ -207,7 +207,7 @@ @@ -218,7 +218,7 @@ @@ -229,7 +229,7 @@ @@ -239,7 +239,7 @@
    remove$: Observable<RemoveEntitiesEvent>
    @@ -249,7 +249,7 @@
    save$: Observable<SaveEntityEvent>
    @@ -267,7 +267,7 @@
    @@ -291,7 +291,7 @@
  • @@ -603,7 +603,7 @@
  • @@ -634,7 +634,7 @@
  • @@ -671,7 +671,7 @@
  • @@ -703,7 +703,7 @@
    @@ -735,7 +735,7 @@
    @@ -790,7 +790,7 @@
    @@ -834,7 +834,7 @@
    diff --git a/docs/classes/todo.html b/docs/classes/todo.html index 0f2bd92..1839593 100644 --- a/docs/classes/todo.html +++ b/docs/classes/todo.html @@ -121,7 +121,7 @@

    Inherited from EntityModelBase.constructor

    Overrides ModelBase.constructor

    Parameters

    @@ -144,7 +144,7 @@ @@ -156,7 +156,7 @@

    Inherited from EntityModelBase.id

    Overrides ModelBase.id

    @@ -166,7 +166,7 @@
    text: string
    @@ -176,7 +176,7 @@
    time: Date
    diff --git a/docs/classes/valueobjectsservice.html b/docs/classes/valueobjectsservice.html index 5a8b302..68f8b1d 100644 --- a/docs/classes/valueobjectsservice.html +++ b/docs/classes/valueobjectsservice.html @@ -111,7 +111,7 @@

    Returns Array<EntityConfigBase>

    @@ -132,7 +132,7 @@

    Parameters

    @@ -159,7 +159,7 @@

    Parameters

    @@ -183,7 +183,7 @@

    Parameters

    diff --git a/docs/enums/dataavailability.html b/docs/enums/dataavailability.html index f269ceb..d76885f 100644 --- a/docs/enums/dataavailability.html +++ b/docs/enums/dataavailability.html @@ -94,7 +94,7 @@
    available:
    @@ -109,7 +109,7 @@
    deep:
    @@ -124,7 +124,7 @@
    flat:
    diff --git a/docs/enums/dataquerysortdirection.html b/docs/enums/dataquerysortdirection.html index 5cbf1ff..4fc02b4 100644 --- a/docs/enums/dataquerysortdirection.html +++ b/docs/enums/dataquerysortdirection.html @@ -86,7 +86,7 @@
    ascending:
    @@ -96,7 +96,7 @@
    descending:
    diff --git a/docs/enums/entityerrortypes.html b/docs/enums/entityerrortypes.html index 441fe30..5608497 100644 --- a/docs/enums/entityerrortypes.html +++ b/docs/enums/entityerrortypes.html @@ -86,7 +86,7 @@
    DataParseError:
    @@ -96,7 +96,7 @@
    HttpError:
    diff --git a/docs/enums/entitygetmethod.html b/docs/enums/entitygetmethod.html index de748fb..c0100a4 100644 --- a/docs/enums/entitygetmethod.html +++ b/docs/enums/entitygetmethod.html @@ -86,7 +86,7 @@
    getItem:
    @@ -96,7 +96,7 @@
    query:
    diff --git a/docs/enums/relationshiptype.html b/docs/enums/relationshiptype.html index 86cbdf2..47bb321 100644 --- a/docs/enums/relationshiptype.html +++ b/docs/enums/relationshiptype.html @@ -86,7 +86,7 @@
    OneToMany:
    @@ -96,7 +96,7 @@
    OneToOne:
    diff --git a/docs/globals.html b/docs/globals.html index b9e369d..7a0f2ba 100644 --- a/docs/globals.html +++ b/docs/globals.html @@ -200,7 +200,7 @@
    DataSetOptionsSort: Array<DataQuerySortField>
    @@ -210,7 +210,7 @@
    EntityConfigFunctionOrValue: function | string
    @@ -220,7 +220,7 @@
    EntityFieldConfigFunctionOrValue: function | string
    @@ -230,7 +230,7 @@
    EntityFields: Map<string, Field>
    @@ -240,7 +240,7 @@
    EntityId: string | number
    @@ -250,7 +250,7 @@
    Index: object
    @@ -268,7 +268,7 @@
    ModelPropertyValue: object
    @@ -286,7 +286,7 @@
    RequestMethod: "GET" | "POST" | "PUT" | "PATCH" | "DELETE"
    @@ -296,7 +296,7 @@
    UrlParams: object
    @@ -317,7 +317,7 @@
    DEFAULT_RELATIONSHIP_TYPES: RelationshipType[] = [RelationshipType.OneToMany, RelationshipType.OneToOne]
    @@ -327,7 +327,7 @@
    DEFAULT_TIMEOUT: 60000 = 60000
    @@ -337,7 +337,7 @@
    DEFAULT_VALUE_ID: "__default" = "__default"
    @@ -347,7 +347,7 @@
    FIELD_DATA_SELF: "__self" = "__self"
    @@ -357,7 +357,7 @@
    entitiesService: EntitiesService = new EntitiesService()
    @@ -367,7 +367,7 @@
    entityFieldsService: EntityFieldsService = new EntityFieldsService
    @@ -377,7 +377,7 @@
    entityRelationshipsService: EntityRelationshipsService = new EntityRelationshipsService
    @@ -387,7 +387,7 @@
    expect: ExpectStatic = chai.expect
    @@ -397,7 +397,7 @@
    transformers: Array<DataTransformer> = [{type: Date,parse: (dateValue:string) => new Date(dateValue),serialize: (date:Date) => date ? date.toISOString() : null},{type: RegExp,parse: (pattern:string) => new RegExp(pattern),serialize: (regExp:RegExp) => regExp ? regExp.toString().match(/^\/(.*)\/$/)[1] : null}]
    @@ -407,7 +407,7 @@
    transformersMap: Map<Function, DataTransformer> = new Map
    @@ -417,7 +417,7 @@
    valueObjectsService: ValueObjectsService = new ValueObjectsService
    @@ -434,7 +434,7 @@
  • Parameters

    @@ -457,7 +457,7 @@
  • Type parameters

    @@ -492,7 +492,7 @@
  • @@ -523,7 +523,7 @@
  • Parameters

    @@ -546,7 +546,7 @@
  • Parameters

    @@ -569,7 +569,7 @@
  • Type parameters

    @@ -613,7 +613,7 @@
  • Type parameters

    @@ -657,7 +657,7 @@
  • Parameters

    @@ -680,7 +680,7 @@
  • Type parameters

    @@ -726,7 +726,7 @@
    defaultConfig: object
    @@ -735,7 +735,7 @@
    allItemsProperty: string = "items"
    @@ -745,7 +745,7 @@
    entityIdProperty: string = "id"
    @@ -756,7 +756,7 @@
    defaultDataOptions: object
    @@ -765,7 +765,7 @@
    allowCache: true = true
    @@ -775,7 +775,7 @@
    availability: deep = DataAvailability.deep
    diff --git a/docs/index.html b/docs/index.html index 2ac659b..2e00520 100644 --- a/docs/index.html +++ b/docs/index.html @@ -3,13 +3,10 @@ - Paris - Under the hood + Paris - -
    @@ -66,17 +63,8 @@

    Paris

    -

    Paris is a TypeScript library for implementing Domain-Driven Design in web apps.

    -

    Contributing

    -

    This project welcomes contributions and suggestions. Most contributions require you to agree to a - Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us - the rights to use your contribution. For details, visit https://cla.microsoft.com.

    -

    When you submit a pull request, a CLA-bot will automatically determine whether you need to provide - a CLA and decorate the PR appropriately (e.g., label, comment). Simply follow the instructions - provided by the bot. You will only need to do this once across all repos using our CLA.

    -

    This project has adopted the Microsoft Open Source Code of Conduct. - For more information see the Code of Conduct FAQ or - contact opencode@microsoft.com with any additional questions or comments.

    +

    Paris is a TypeScript library for implementing Domain-Driven Design in web apps. + Paris, fashion capital of the world, where all the models want to be.

    Usage

    First, define an Entity:

    @Entity({
    @@ -98,6 +86,19 @@ paris.getItemById(TodoItem, 1).subscribe(console.log("Todo item with ID 1: ", todoItem);
     });
     
    +

    Advanced

    +

    Check the Wiki for advanced uses and explanations.

    +

    Check the Source Typescript models for detailed look under the hood.

    +

    Contributing

    +

    This project welcomes contributions and suggestions. Most contributions require you to agree to a + Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us + the rights to use your contribution. For details, visit https://cla.microsoft.com.

    +

    When you submit a pull request, a CLA-bot will automatically determine whether you need to provide + a CLA and decorate the PR appropriately (e.g., label, comment). Simply follow the instructions + provided by the bot. You will only need to do this once across all repos using our CLA.

    +

    This project has adopted the Microsoft Open Source Code of Conduct. + For more information see the Code of Conduct FAQ or + contact opencode@microsoft.com with any additional questions or comments.