@fluidframework/synthesize 0.55.0 → 0.56.1

package/lib/dependencyContainer.js

@@ -14,14 +14,10 @@ export class DependencyContainer {
     }
     get IFluidDependencySynthesizer() { return this; }
     /**
-     * @deprecated - use has instead
-     * {@inheritDoc (IFluidDependencySynthesizer:interface).registeredTypes}
-     */
-    get registeredTypes() {
-        return this.providers.keys();
-    }
-    /**
-     * {@inheritDoc (IFluidDependencySynthesizer:interface).register}
+     * Add a new provider
+     * @param type - Name of the Type T being provided
+     * @param provider - A provider that will resolve the T correctly when asked
+     * @throws - If passing a type that's already registered
      */
     register(type, provider) {
         if (this.providers.has(type)) {
@@ -30,7 +26,8 @@ export class DependencyContainer {
         this.providers.set(type, provider);
     }
     /**
-     * {@inheritDoc (IFluidDependencySynthesizer:interface).unregister}
+     * Remove a provider
+     * @param type - Name of the provider to remove
      */
     unregister(type) {
         if (this.providers.has(type)) {
@@ -60,26 +57,9 @@ export class DependencyContainer {
         }
         return false;
     }
-    /**
-     * @deprecated - use synthesize or has instead
-     *
-     * {@inheritDoc (IFluidDependencySynthesizer:interface).getProvider}
-     */
-    getProvider(type) {
-        // If we have the provider return it
-        const provider = this.providers.get(type);
-        if (provider) {
-            return provider;
-        }
-        for (const parent of this.parents) {
-            const p = parent.getProvider(type);
-            if (p !== undefined) {
-                return p;
-            }
-        }
-        return undefined;
-    }
     generateRequired(base, types) {
+        if (types === undefined)
+            return;
         for (const key of Object.keys(types)) {
             const provider = this.resolveProvider(key);
             if (provider === undefined) {
@@ -89,11 +69,15 @@ export class DependencyContainer {
         }
     }
     generateOptional(base, types) {
+        var _a;
+        if (types === undefined)
+            return;
         for (const key of Object.keys(types)) {
-            const provider = this.resolveProvider(key);
-            if (provider !== undefined) {
-                Object.defineProperty(base, key, provider);
-            }
+            // back-compat: in 0.56 we allow undefined in the types, but we didn't before
+            // this will keep runtime back compat, eventually we should support undefined properties
+            // rather than properties that return promises that resolve to undefined
+            const provider = (_a = this.resolveProvider(key)) !== null && _a !== void 0 ? _a : { get: () => Promise.resolve(undefined) };
+            Object.defineProperty(base, key, provider);
         }
     }
     resolveProvider(t) {
@@ -101,9 +85,7 @@ export class DependencyContainer {
         const provider = this.providers.get(t);
         if (provider === undefined) {
             for (const parent of this.parents) {
-                // eslint-disable-next-line @typescript-eslint/consistent-type-assertions
                 const sp = { [t]: t };
-                // eslint-disable-next-line @typescript-eslint/ban-types
                 const syn = parent.synthesize(sp, {});
                 const descriptor = Object.getOwnPropertyDescriptor(syn, t);
                 if (descriptor !== undefined) {

package/lib/dependencyContainer.js.map

@@ -1 +1 @@
-{"version":3,"file":"dependencyContainer.js","sourceRoot":"","sources":["../src/dependencyContainer.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAYH,OAAO,EACH,2BAA2B,GAC9B,MAAM,+BAA+B,CAAC;AAEvC;;;GAGG;AACH,MAAM,OAAO,mBAAmB;IAa5B,YAAmB,GAAI,OAAoD;QAZ1D,cAAS,GAAG,IAAI,GAAG,EAAgD,CAAC;QAajF,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC,EAAoC,EAAE,CAAC,CAAC,KAAK,SAAS,CAAC,CAAC;IAC5F,CAAC;IAZD,IAAW,2BAA2B,KAAK,OAAO,IAAI,CAAC,CAAC,CAAC;IAEzD;;;OAGG;IACH,IAAW,eAAe;QACtB,OAAO,IAAI,CAAC,SAAS,CAAC,IAAI,EAAE,CAAC;IACjC,CAAC;IAMD;;OAEG;IACI,QAAQ,CAA+B,IAAO,EAAE,QAAgC;QACnF,IAAI,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,IAAI,CAAC,EAAE;YAC1B,MAAM,IAAI,KAAK,CAAC,6CAA6C,IAAI,sBAAsB,CAAC,CAAC;SAC5F;QAED,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,IAAI,EAAE,QAAQ,CAAC,CAAC;IACvC,CAAC;IAED;;OAEG;IACI,UAAU,CAA+B,IAAO;QACnD,IAAI,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,IAAI,CAAC,EAAE;YAC1B,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;SAC/B;IACL,CAAC;IAED;;OAEG;IACI,UAAU,CAIT,aAA2C,EAC3C,aAA2C;QAE/C,MAAM,IAAI,GAAmE,EAAS,CAAC;QACvF,IAAI,CAAC,gBAAgB,CAAI,IAAI,EAAE,aAAa,CAAC,CAAC;QAC9C,IAAI,CAAC,gBAAgB,CAAI,IAAI,EAAE,aAAa,CAAC,CAAC;QAC9C,MAAM,CAAC,cAAc,CAAC,IAAI,EAAE,2BAA2B,EAAE,EAAE,GAAG,EAAE,GAAG,EAAE,CAAC,IAAI,EAAE,CAAC,CAAC;QAC9E,OAAO,IAAI,CAAC;IAChB,CAAC;IAED;;;OAGG;IACI,GAAG,CAAC,IAA0B,EAAE,cAAwB;QAC3D,IAAI,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,IAAI,CAAC,EAAE;YAC1B,OAAO,IAAI,CAAC;SACf;QACD,IAAI,cAAc,KAAK,IAAI,EAAE;YACzB,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,CAA8B,EAAE,EAAE,CAAC,CAAC,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC,CAAC;SAC7E;QACD,OAAO,KAAK,CAAC;IACjB,CAAC;IAED;;;;OAIG;IACI,WAAW,CAA+B,IAAO;QACpD,oCAAoC;QACpC,MAAM,QAAQ,GAAG,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;QAC1C,IAAI,QAAQ,EAAE;YACV,OAAO,QAAQ,CAAC;SACnB;QAED,KAAI,MAAM,MAAM,IAAI,IAAI,CAAC,OAAO,EAAE;YAC9B,MAAM,CAAC,GAAG,MAAM,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC;YACnC,IAAI,CAAC,KAAK,SAAS,EAAE;gBACjB,OAAO,CAAC,CAAC;aACZ;SACJ;QAED,OAAO,SAAS,CAAC;IACrB,CAAC;IAEO,gBAAgB,CACpB,IAAyD,EACzD,KAAmC;QAEnC,KAAI,MAAM,GAAG,IAAI,MAAM,CAAC,IAAI,CAAC,KAAK,CAAsC,EAAE;YACtE,MAAM,QAAQ,GAAG,IAAI,CAAC,eAAe,CAAC,GAAG,CAAC,CAAC;YAC3C,IAAG,QAAQ,KAAK,SAAS,EAAE;gBACvB,MAAM,IAAI,KAAK,CAAC,uEAAuE,GAAG,EAAE,CAAC,CAAC;aACjG;YACD,MAAM,CAAC,cAAc,CACjB,IAAI,EACJ,GAAG,EACH,QAAQ,CACX,CAAC;SACL;IACL,CAAC;IAEO,gBAAgB,CACpB,IAAyD,EACzD,KAAmC;QAEnC,KAAI,MAAM,GAAG,IAAI,MAAM,CAAC,IAAI,CAAC,KAAK,CAAsC,EAAE;YACtE,MAAM,QAAQ,GAAG,IAAI,CAAC,eAAe,CAAC,GAAG,CAAC,CAAC;YAC3C,IAAG,QAAQ,KAAK,SAAS,EAAE;gBACvB,MAAM,CAAC,cAAc,CACjB,IAAI,EACJ,GAAG,EACH,QAAQ,CACX,CAAC;aACL;SACJ;IACL,CAAC;IAEO,eAAe,CAA+B,CAAI;QACtD,oCAAoC;QACpC,MAAM,QAAQ,GAAG,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC;QACvC,IAAI,QAAQ,KAAK,SAAS,EAAE;YACxB,KAAI,MAAM,MAAM,IAAI,IAAI,CAAC,OAAO,EAAE;gBAC9B,yEAAyE;gBACzE,MAAM,EAAE,GAAG,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC,EAAsD,CAAC;gBAC1E,wDAAwD;gBACxD,MAAM,GAAG,GAAG,MAAM,CAAC,UAAU,CACzB,EAAE,EACF,EAAE,CAAC,CAAC;gBACR,MAAM,UAAU,GAAG,MAAM,CAAC,wBAAwB,CAAC,GAAG,EAAE,CAAC,CAAC,CAAC;gBAC3D,IAAI,UAAU,KAAK,SAAS,EAAE;oBAC1B,OAAO,UAAU,CAAC;iBACrB;aACJ;YACD,OAAO,SAAS,CAAC;SACpB;QAED,+EAA+E;QAC/E,IAAI,OAAO,QAAQ,KAAK,UAAU,EAAE;YAChC,OAAO;gBACH,GAAG;oBACC,IAAI,QAAQ,IAAI,OAAO,QAAQ,KAAK,UAAU,EAAE;wBAC5C,OAAO,OAAO,CAAC,OAAO,CAAC,IAAI,CAAC,2BAA2B,CAAC,CAAC;6BACpD,IAAI,CAAC,KAAK,EAAE,GAAG,EAAgB,EAAE,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC;6BAChD,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,aAAD,CAAC,uBAAD,CAAC,CAAG,CAAC,CAAC,CAAC,CAAC;qBAC5B;gBACL,CAAC;aACJ,CAAC;SACL;QACD,OAAO;YACC,GAAG;gBACC,IAAI,QAAQ,EAAE;oBACV,OAAO,OAAO,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE;wBACxC,IAAI,CAAC,EAAE;4BACH,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC;yBACf;oBACL,CAAC,CAAC,CAAC;iBACN;YACL,CAAC;SACJ,CAAC;IACV,CAAC;CACJ","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport { IFluidObject } from \"@fluidframework/core-interfaces\";\n\nimport {\n    AsyncFluidObjectProvider,\n    FluidObjectSymbolProvider,\n    FluidObjectProvider,\n    FluidObjectKey,\n    AsyncOptionalFluidObjectProvider,\n    AsyncRequiredFluidObjectProvider,\n} from \"./types\";\nimport {\n    IFluidDependencySynthesizer,\n} from \"./IFluidDependencySynthesizer\";\n\n/**\n * DependencyContainer is similar to a IoC Container. It takes providers and will\n * synthesize an object based on them when requested.\n */\nexport class DependencyContainer implements IFluidDependencySynthesizer {\n    private readonly providers = new Map<keyof IFluidObject, FluidObjectProvider<any>>();\n    private readonly parents: IFluidDependencySynthesizer[];\n    public get IFluidDependencySynthesizer() { return this; }\n\n    /**\n     * @deprecated - use has instead\n     * {@inheritDoc (IFluidDependencySynthesizer:interface).registeredTypes}\n     */\n    public get registeredTypes(): Iterable<(keyof IFluidObject)> {\n        return this.providers.keys();\n    }\n\n    public constructor(... parents: (IFluidDependencySynthesizer | undefined)[]) {\n        this.parents = parents.filter((v): v is IFluidDependencySynthesizer => v !== undefined);\n    }\n\n    /**\n     * {@inheritDoc (IFluidDependencySynthesizer:interface).register}\n     */\n    public register<T extends keyof IFluidObject>(type: T, provider: FluidObjectProvider<T>): void {\n        if (this.providers.has(type)) {\n            throw new Error(`Attempting to register a provider of type ${type} that already exists`);\n        }\n\n        this.providers.set(type, provider);\n    }\n\n    /**\n     * {@inheritDoc (IFluidDependencySynthesizer:interface).unregister}\n     */\n    public unregister<T extends keyof IFluidObject>(type: T): void {\n        if (this.providers.has(type)) {\n            this.providers.delete(type);\n        }\n    }\n\n    /**\n     * {@inheritDoc (IFluidDependencySynthesizer:interface).synthesize}\n     */\n    public synthesize<\n        O extends IFluidObject,\n        // eslint-disable-next-line @typescript-eslint/ban-types\n        R extends IFluidObject = {}>(\n            optionalTypes: FluidObjectSymbolProvider<O>,\n            requiredTypes: FluidObjectSymbolProvider<R>,\n    ): AsyncFluidObjectProvider<FluidObjectKey<O>, FluidObjectKey<R>> {\n        const base: AsyncFluidObjectProvider<FluidObjectKey<O>, FluidObjectKey<R>> = {} as any;\n        this.generateRequired<R>(base, requiredTypes);\n        this.generateOptional<O>(base, optionalTypes);\n        Object.defineProperty(base, IFluidDependencySynthesizer, { get: () => this });\n        return base;\n    }\n\n    /**\n     * {@inheritDoc (IFluidDependencySynthesizer:interface).has}\n     * @param excludeParents - If true, exclude checking parent registries\n     */\n    public has(type: (keyof IFluidObject), excludeParents?: boolean): boolean {\n        if (this.providers.has(type)) {\n            return true;\n        }\n        if (excludeParents !== true) {\n            return this.parents.some((p: IFluidDependencySynthesizer) => p.has(type));\n        }\n        return false;\n    }\n\n    /**\n     * @deprecated - use synthesize or has instead\n     *\n     * {@inheritDoc (IFluidDependencySynthesizer:interface).getProvider}\n     */\n    public getProvider<T extends keyof IFluidObject>(type: T): FluidObjectProvider<T> | undefined {\n        // If we have the provider return it\n        const provider = this.providers.get(type);\n        if (provider) {\n            return provider;\n        }\n\n        for(const parent of this.parents) {\n            const p = parent.getProvider(type);\n            if (p !== undefined) {\n                return p;\n            }\n        }\n\n        return undefined;\n    }\n\n    private generateRequired<T extends IFluidObject>(\n        base: AsyncRequiredFluidObjectProvider<FluidObjectKey<T>>,\n        types: FluidObjectSymbolProvider<T>,\n    ) {\n        for(const key of Object.keys(types) as unknown as (keyof IFluidObject)[]) {\n            const provider = this.resolveProvider(key);\n            if(provider === undefined) {\n                throw new Error(`Object attempted to be created without registered required provider ${key}`);\n            }\n            Object.defineProperty(\n                base,\n                key,\n                provider,\n            );\n        }\n    }\n\n    private generateOptional<T extends IFluidObject>(\n        base: AsyncOptionalFluidObjectProvider<FluidObjectKey<T>>,\n        types: FluidObjectSymbolProvider<T>,\n    ) {\n        for(const key of Object.keys(types) as unknown as (keyof IFluidObject)[]) {\n            const provider = this.resolveProvider(key);\n            if(provider !== undefined) {\n                Object.defineProperty(\n                    base,\n                    key,\n                    provider,\n                );\n            }\n        }\n    }\n\n    private resolveProvider<T extends keyof IFluidObject>(t: T): PropertyDescriptor | undefined {\n        // If we have the provider return it\n        const provider = this.providers.get(t);\n        if (provider === undefined) {\n            for(const parent of this.parents) {\n                // eslint-disable-next-line @typescript-eslint/consistent-type-assertions\n                const sp = { [t]: t } as FluidObjectSymbolProvider<Pick<IFluidObject, T>>;\n                // eslint-disable-next-line @typescript-eslint/ban-types\n                const syn = parent.synthesize<Pick<IFluidObject, T>,{}>(\n                    sp,\n                    {});\n                const descriptor = Object.getOwnPropertyDescriptor(syn, t);\n                if (descriptor !== undefined) {\n                    return descriptor;\n                }\n            }\n            return undefined;\n        }\n\n        // The double nested gets are required for lazy loading the provider resolution\n        if (typeof provider === \"function\") {\n            return {\n                get() {\n                    if (provider && typeof provider === \"function\") {\n                        return Promise.resolve(this[IFluidDependencySynthesizer])\n                            .then(async (fds): Promise<any> => provider(fds))\n                            .then((p) => p?.[t]);\n                    }\n                },\n            };\n        }\n        return {\n                get() {\n                    if (provider) {\n                        return Promise.resolve(provider).then((p) => {\n                            if (p) {\n                                return p[t];\n                            }\n                        });\n                    }\n                },\n            };\n    }\n}\n"]}
+{"version":3,"file":"dependencyContainer.js","sourceRoot":"","sources":["../src/dependencyContainer.ts"],"names":[],"mappings":"AAAA;;;GAGG;AASH,OAAO,EACH,2BAA2B,GAC9B,MAAM,+BAA+B,CAAC;AAEvC;;;GAGG;AACH,MAAM,OAAO,mBAAmB;IAK5B,YAAmB,GAAI,OAAoD;QAJ1D,cAAS,GAAG,IAAI,GAAG,EAAwC,CAAC;QAKzE,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC,EAAoC,EAAE,CAAC,CAAC,KAAK,SAAS,CAAC,CAAC;IAC5F,CAAC;IAJD,IAAW,2BAA2B,KAAK,OAAO,IAAI,CAAC,CAAC,CAAC;IAMzD;;;;;OAKG;IACI,QAAQ,CAAoC,IAAO,EAAE,QAA4C;QACpG,IAAI,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,IAAI,CAAC,EAAE;YAC1B,MAAM,IAAI,KAAK,CAAC,6CAA6C,IAAI,sBAAsB,CAAC,CAAC;SAC5F;QAED,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,IAAI,EAAE,QAAQ,CAAC,CAAC;IACvC,CAAC;IAED;;;OAGG;IACI,UAAU,CAAC,IAAgB;QAC9B,IAAI,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,IAAI,CAAC,EAAE;YAC1B,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;SAC/B;IACL,CAAC;IAED;;OAEG;IACI,UAAU,CACb,aAA2C,EAC3C,aAAqD;QAErD,MAAM,IAAI,GAAmC,EAAS,CAAC;QACvD,IAAI,CAAC,gBAAgB,CAAI,IAAI,EAAE,aAAa,CAAC,CAAC;QAC9C,IAAI,CAAC,gBAAgB,CAAI,IAAI,EAAE,aAAa,CAAC,CAAC;QAC9C,MAAM,CAAC,cAAc,CAAC,IAAI,EAAE,2BAA2B,EAAE,EAAE,GAAG,EAAE,GAAG,EAAE,CAAC,IAAI,EAAE,CAAC,CAAC;QAC9E,OAAO,IAAI,CAAC;IAChB,CAAC;IAED;;;OAGG;IACI,GAAG,CAAC,IAAY,EAAE,cAAwB;QAC7C,IAAI,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,IAAkB,CAAC,EAAE;YACxC,OAAO,IAAI,CAAC;SACf;QACD,IAAI,cAAc,KAAK,IAAI,EAAE;YACzB,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,CAA8B,EAAE,EAAE,CAAC,CAAC,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC,CAAC;SAC7E;QACD,OAAO,KAAK,CAAC;IACjB,CAAC;IAEO,gBAAgB,CACpB,IAAyC,EACzC,KAA6C;QAE7C,IAAG,KAAK,KAAK,SAAS;YAAE,OAAO;QAC/B,KAAI,MAAM,GAAG,IAAI,MAAM,CAAC,IAAI,CAAC,KAAK,CAA8B,EAAE;YAC9D,MAAM,QAAQ,GAAG,IAAI,CAAC,eAAe,CAAC,GAAG,CAAC,CAAC;YAC3C,IAAG,QAAQ,KAAK,SAAS,EAAE;gBACvB,MAAM,IAAI,KAAK,CAAC,uEAAuE,GAAG,EAAE,CAAC,CAAC;aACjG;YACD,MAAM,CAAC,cAAc,CACjB,IAAI,EACJ,GAAG,EACH,QAAQ,CACX,CAAC;SACL;IACL,CAAC;IAEO,gBAAgB,CACpB,IAAyC,EACzC,KAAmC;;QAEnC,IAAG,KAAK,KAAK,SAAS;YAAE,OAAO;QAC/B,KAAI,MAAM,GAAG,IAAI,MAAM,CAAC,IAAI,CAAC,KAAK,CAA8B,EAAE;YAC9D,6EAA6E;YAC7E,wFAAwF;YACxF,wEAAwE;YACxE,MAAM,QAAQ,SAAG,IAAI,CAAC,eAAe,CAAC,GAAG,CAAC,mCAAI,EAAC,GAAG,EAAC,GAAE,EAAE,CAAA,OAAO,CAAC,OAAO,CAAC,SAAS,CAAC,EAAC,CAAC;YACnF,MAAM,CAAC,cAAc,CACjB,IAAI,EACJ,GAAG,EACH,QAAQ,CACX,CAAC;SACL;IACL,CAAC;IAEO,eAAe,CAAuB,CAAI;QAC9C,oCAAoC;QACpC,MAAM,QAAQ,GAAG,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC;QACvC,IAAI,QAAQ,KAAK,SAAS,EAAE;YACxB,KAAI,MAAM,MAAM,IAAI,IAAI,CAAC,OAAO,EAAE;gBAC9B,MAAM,EAAE,GAAG,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC,EAA8C,CAAC;gBAClE,MAAM,GAAG,GAAG,MAAM,CAAC,UAAU,CACzB,EAAE,EACF,EAAE,CAAC,CAAC;gBACR,MAAM,UAAU,GAAG,MAAM,CAAC,wBAAwB,CAAC,GAAG,EAAE,CAAC,CAAC,CAAC;gBAC3D,IAAI,UAAU,KAAK,SAAS,EAAE;oBAC1B,OAAO,UAAU,CAAC;iBACrB;aACJ;YACD,OAAO,SAAS,CAAC;SACpB;QAED,+EAA+E;QAC/E,IAAI,OAAO,QAAQ,KAAK,UAAU,EAAE;YAChC,OAAO;gBACH,GAAG;oBACC,IAAI,QAAQ,IAAI,OAAO,QAAQ,KAAK,UAAU,EAAE;wBAC5C,OAAO,OAAO,CAAC,OAAO,CAAC,IAAI,CAAC,2BAA2B,CAAC,CAAC;6BACpD,IAAI,CAAC,KAAK,EAAE,GAAG,EAAgB,EAAE,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC;6BAChD,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,aAAD,CAAC,uBAAD,CAAC,CAAG,CAAC,CAAC,CAAC,CAAC;qBAC5B;gBACL,CAAC;aACJ,CAAC;SACL;QACD,OAAO;YACC,GAAG;gBACC,IAAI,QAAQ,EAAE;oBACV,OAAO,OAAO,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE;wBACxC,IAAI,CAAC,EAAE;4BACH,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC;yBACf;oBACL,CAAC,CAAC,CAAC;iBACN;YACL,CAAC;SACJ,CAAC;IACV,CAAC;CACJ","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport {\n    AsyncFluidObjectProvider,\n    FluidObjectSymbolProvider,\n    FluidObjectProvider,\n    AsyncOptionalFluidObjectProvider,\n    AsyncRequiredFluidObjectProvider,\n} from \"./types\";\nimport {\n    IFluidDependencySynthesizer,\n} from \"./IFluidDependencySynthesizer\";\n\n/**\n * DependencyContainer is similar to a IoC Container. It takes providers and will\n * synthesize an object based on them when requested.\n */\nexport class DependencyContainer<TMap> implements IFluidDependencySynthesizer {\n    private readonly providers = new Map<keyof TMap, FluidObjectProvider<any>>();\n    private readonly parents: IFluidDependencySynthesizer[];\n    public get IFluidDependencySynthesizer() { return this; }\n\n    public constructor(... parents: (IFluidDependencySynthesizer | undefined)[]) {\n        this.parents = parents.filter((v): v is IFluidDependencySynthesizer => v !== undefined);\n    }\n\n    /**\n     * Add a new provider\n     * @param type - Name of the Type T being provided\n     * @param provider - A provider that will resolve the T correctly when asked\n     * @throws - If passing a type that's already registered\n     */\n    public register<T extends keyof TMap = keyof TMap>(type: T, provider: FluidObjectProvider<Pick<TMap, T>>): void {\n        if (this.providers.has(type)) {\n            throw new Error(`Attempting to register a provider of type ${type} that already exists`);\n        }\n\n        this.providers.set(type, provider);\n    }\n\n    /**\n     * Remove a provider\n     * @param type - Name of the provider to remove\n     */\n    public unregister(type: keyof TMap): void {\n        if (this.providers.has(type)) {\n            this.providers.delete(type);\n        }\n    }\n\n    /**\n     * {@inheritDoc (IFluidDependencySynthesizer:interface).synthesize}\n     */\n    public synthesize<O, R = undefined | Record<string, never>>(\n        optionalTypes: FluidObjectSymbolProvider<O>,\n        requiredTypes: Required<FluidObjectSymbolProvider<R>>,\n    ): AsyncFluidObjectProvider<O, R> {\n        const base: AsyncFluidObjectProvider<O, R> = {} as any;\n        this.generateRequired<R>(base, requiredTypes);\n        this.generateOptional<O>(base, optionalTypes);\n        Object.defineProperty(base, IFluidDependencySynthesizer, { get: () => this });\n        return base;\n    }\n\n    /**\n     * {@inheritDoc (IFluidDependencySynthesizer:interface).has}\n     * @param excludeParents - If true, exclude checking parent registries\n     */\n    public has(type: string, excludeParents?: boolean): boolean {\n        if (this.providers.has(type as keyof TMap)) {\n            return true;\n        }\n        if (excludeParents !== true) {\n            return this.parents.some((p: IFluidDependencySynthesizer) => p.has(type));\n        }\n        return false;\n    }\n\n    private generateRequired<T>(\n        base: AsyncRequiredFluidObjectProvider<T>,\n        types: Required<FluidObjectSymbolProvider<T>>,\n    ) {\n        if(types === undefined) return;\n        for(const key of Object.keys(types) as unknown as (keyof TMap)[]) {\n            const provider = this.resolveProvider(key);\n            if(provider === undefined) {\n                throw new Error(`Object attempted to be created without registered required provider ${key}`);\n            }\n            Object.defineProperty(\n                base,\n                key,\n                provider,\n            );\n        }\n    }\n\n    private generateOptional<T>(\n        base: AsyncOptionalFluidObjectProvider<T>,\n        types: FluidObjectSymbolProvider<T>,\n    ) {\n        if(types === undefined) return;\n        for(const key of Object.keys(types) as unknown as (keyof TMap)[]) {\n            // back-compat: in 0.56 we allow undefined in the types, but we didn't before\n            // this will keep runtime back compat, eventually we should support undefined properties\n            // rather than properties that return promises that resolve to undefined\n            const provider = this.resolveProvider(key) ?? {get:()=>Promise.resolve(undefined)};\n            Object.defineProperty(\n                base,\n                key,\n                provider,\n            );\n        }\n    }\n\n    private resolveProvider<T extends keyof TMap>(t: T): PropertyDescriptor | undefined {\n        // If we have the provider return it\n        const provider = this.providers.get(t);\n        if (provider === undefined) {\n            for(const parent of this.parents) {\n                const sp = { [t]: t } as FluidObjectSymbolProvider<Pick<TMap, T>>;\n                const syn = parent.synthesize<Pick<TMap, T>,{}>(\n                    sp,\n                    {});\n                const descriptor = Object.getOwnPropertyDescriptor(syn, t);\n                if (descriptor !== undefined) {\n                    return descriptor;\n                }\n            }\n            return undefined;\n        }\n\n        // The double nested gets are required for lazy loading the provider resolution\n        if (typeof provider === \"function\") {\n            return {\n                get() {\n                    if (provider && typeof provider === \"function\") {\n                        return Promise.resolve(this[IFluidDependencySynthesizer])\n                            .then(async (fds): Promise<any> => provider(fds))\n                            .then((p) => p?.[t]);\n                    }\n                },\n            };\n        }\n        return {\n                get() {\n                    if (provider) {\n                        return Promise.resolve(provider).then((p) => {\n                            if (p) {\n                                return p[t];\n                            }\n                        });\n                    }\n                },\n            };\n    }\n}\n"]}

package/lib/types.js.map

@@ -1 +1 @@
-{"version":3,"file":"types.js","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\nimport { IFluidObject } from \"@fluidframework/core-interfaces\";\nimport { IFluidDependencySynthesizer } from \".\";\n\nexport type FluidObjectKey<T extends IFluidObject> = keyof T & keyof IFluidObject;\n\n/**\n * This is a condensed version of Record that requires the object has all\n * the IFluidObject properties as its type mapped to a string representation\n * of that property.\n *\n * @example - \\{ IFoo: \"IFoo\" \\}\n */\nexport type FluidObjectSymbolProvider<T extends IFluidObject> = {\n    [P in FluidObjectKey<T>]: FluidObjectKey<T> & P;\n};\n\n/**\n * This is a condensed version of Record that requires the object has all\n * the IFluidObject properties as its type mapped to an object that implements\n * the property.\n */\nexport type AsyncRequiredFluidObjectProvider<T extends keyof IFluidObject> = {\n    [P in T]: Promise<NonNullable<IFluidObject[P]>>\n};\n\n/**\n * This is a condensed version of Record that requires the object has all\n * the IFluidObject properties as its type, mapped to an object that implements\n * the property or undefined.\n */\nexport type AsyncOptionalFluidObjectProvider<T extends keyof IFluidObject> = {\n    [P in T]: Promise<IFluidObject[P] | undefined>;\n};\n\n/**\n * Combined type for Optional and Required Async Fluid object Providers\n */\nexport type AsyncFluidObjectProvider<O extends keyof IFluidObject, R extends keyof IFluidObject>\n    = AsyncOptionalFluidObjectProvider<O> & AsyncRequiredFluidObjectProvider<R>;\n\n/**\n * Provided a keyof IFluidObject will ensure the type is an instance of that type\n */\nexport type NonNullableFluidObject<T extends keyof IFluidObject> = NonNullable<IFluidObject[T]>;\n\n/**\n * Multiple ways to provide a Fluid object.\n */\nexport type FluidObjectProvider<T extends keyof IFluidObject> =\n    NonNullableFluidObject<T>\n    | Promise<NonNullableFluidObject<T>>\n    | ((dependencyContainer: IFluidDependencySynthesizer) => NonNullableFluidObject<T>)\n    | ((dependencyContainer: IFluidDependencySynthesizer) => Promise<NonNullableFluidObject<T>>);\n\n/**\n * @deprecated - create a new DependencyContainer instead\n * ProviderEntry is a mapping of the type to the Provider\n */\nexport interface ProviderEntry<T extends keyof IFluidObject> {\n    type: T;\n    provider: FluidObjectProvider<T>\n}\n\n/**\n * @deprecated - create a new DependencyContainer instead\n * A mapping of ProviderEntries\n */\nexport type DependencyContainerRegistry = Iterable<ProviderEntry<any>>;\n"]}
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\nimport { IFluidDependencySynthesizer } from \".\";\n/**\n * This is a condensed version of Record that requires the object has all\n * the IFluidObject properties as its type mapped to a string representation\n * of that property.\n *\n * @example - \\{ IFoo: \"IFoo\" \\}\n */\nexport type FluidObjectSymbolProvider<T> = {\n    [P in keyof T]?: P;\n};\n\n/**\n * This is a condensed version of Record that requires the object has all\n * the IFluidObject properties as its type mapped to an object that implements\n * the property.\n */\nexport type AsyncRequiredFluidObjectProvider<T> =  T extends undefined ? Record<string, never> : {\n    [P in keyof T]: Promise<NonNullable<Exclude<T[P], undefined | null>>>\n};\n\n/**\n * This is a condensed version of Record that requires the object has all\n * the IFluidObject properties as its type, mapped to an object that implements\n * the property or undefined.\n */\nexport type AsyncOptionalFluidObjectProvider<T> = T extends undefined\n    ? Record<string, never>\n    : {\n        [P in keyof T]?: Promise<T[P] | undefined>;\n    };\n\n/**\n * Combined type for Optional and Required Async Fluid object Providers\n */\nexport type AsyncFluidObjectProvider<O, R = undefined>\n    = AsyncOptionalFluidObjectProvider<O> & AsyncRequiredFluidObjectProvider<R>;\n\n/**\n * Multiple ways to provide a Fluid object.\n */\nexport type FluidObjectProvider<T> =\n    NonNullable<T>\n    | Promise<NonNullable<T>>\n    | ((dependencyContainer: IFluidDependencySynthesizer) => NonNullable<T>)\n    | ((dependencyContainer: IFluidDependencySynthesizer) => Promise<NonNullable<T>>);"]}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@fluidframework/synthesize",
-  "version": "0.55.0",
+  "version": "0.56.1",
   "description": "A library for synthesizing scope objects.",
   "homepage": "https://fluidframework.com",
   "repository": "https://github.com/microsoft/FluidFramework",
@@ -57,14 +57,12 @@
     ],
     "temp-directory": "nyc/.nyc_output"
   },
-  "dependencies": {
-    "@fluidframework/core-interfaces": "^0.41.0"
-  },
   "devDependencies": {
     "@fluidframework/build-common": "^0.23.0",
-    "@fluidframework/datastore": "^0.55.0",
+    "@fluidframework/core-interfaces": "^0.42.0",
+    "@fluidframework/datastore": "^0.56.1",
     "@fluidframework/eslint-config-fluid": "^0.25.0",
-    "@fluidframework/mocha-test-setup": "^0.55.0",
+    "@fluidframework/mocha-test-setup": "^0.56.1",
     "@microsoft/api-extractor": "^7.16.1",
     "@rushstack/eslint-config": "^2.5.1",
     "@types/mocha": "^8.2.2",