@xyo-network/module-model 2.92.0 → 2.92.2

package/dist/node/Config.d.ts

@@ -1,59 +0,0 @@
-import { Address } from '@xylabs/hex';
-import { EmptyObject, WithAdditional } from '@xylabs/object';
-import { RetryConfig } from '@xylabs/retry';
-import { Payload, Schema } from '@xyo-network/payload-model';
-import { Labels } from './Labels';
-import { ModuleIdentifier, ModuleName } from './ModuleIdentifier';
-export type ModuleConfigSchema = 'network.xyo.module.config';
-export declare const ModuleConfigSchema: ModuleConfigSchema;
-export type CosigningAddressSet = string[];
-export type SchemaString = string;
-export type NameOrAddress = Address | ModuleName;
-export interface ArchivingModuleConfig {
-    readonly archiving?: {
-        readonly archivists?: ModuleIdentifier[];
-    };
-}
-export type ModuleConfig<TConfig extends EmptyObject | Payload | void = void, TSchema extends Schema | void = void> = Payload<WithAdditional<{
-    /** @field The name/address of the Archivist to use for this module */
-    readonly archivist?: ModuleIdentifier;
-    /**
-     * @field The labels used for this module. If a label is specified, then the
-     * ModuleFactoryLocator will attempt to find a ModuleFactory with the corresponding
-     * labels to construct this module.
-     */
-    readonly labels?: Labels;
-    /** @field Friendly name of module (not collision resistent). Can be used to resolve module when registered/attached to Node. */
-    readonly name?: ModuleName;
-    /** @field paging settings for queries */
-    readonly paging?: Record<string, {
-        size?: number;
-    }>;
-    readonly retry?: RetryConfig;
-    schema: TConfig extends Payload ? TConfig['schema'] : ModuleConfigSchema;
-    /** @field The query schemas and allowed/disallowed addresses which are allowed to issue them against the module. If both allowed and disallowed is specified, then disallowed takes priority. */
-    readonly security?: {
-        /** @field Will the module process queries that have unsigned BoundWitness in query tuples */
-        readonly allowAnonymous?: boolean;
-        /** @field If schema in record, then only these address sets can access query */
-        readonly allowed?: Record<SchemaString, (Address | CosigningAddressSet)[]>;
-        /** @field If schema in record, then anyone except these addresses can access query */
-        readonly disallowed?: Record<SchemaString, Address[]>;
-    };
-    /** @field sign every query */
-    readonly sign?: boolean;
-    /** @field Store the queries made to the module in an archivist if possible */
-    readonly storeQueries?: boolean;
-    /** @field add a timestamp payload to every query  */
-    readonly timestamp?: boolean;
-} & ArchivingModuleConfig, TConfig>, TSchema>;
-export type AnyConfigSchema<TConfig extends Omit<ModuleConfig, 'schema'> & {
-    schema: string;
-} = Omit<ModuleConfig, 'schema'> & {
-    schema: string;
-}> = ModuleConfig<TConfig, string>;
-export type OptionalConfigSchema<TConfig extends AnyConfigSchema<ModuleConfig> = AnyConfigSchema<ModuleConfig>> = Omit<TConfig, 'schema'> & {
-    schema?: TConfig['schema'];
-};
-export type AnyModuleConfig = AnyConfigSchema<ModuleConfig>;
-//# sourceMappingURL=Config.d.ts.map

package/dist/node/Config.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"Config.d.ts","sourceRoot":"","sources":["../../src/Config.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,MAAM,aAAa,CAAA;AACrC,OAAO,EAAE,WAAW,EAAE,cAAc,EAAE,MAAM,gBAAgB,CAAA;AAC5D,OAAO,EAAE,WAAW,EAAE,MAAM,eAAe,CAAA;AAC3C,OAAO,EAAE,OAAO,EAAE,MAAM,EAAE,MAAM,4BAA4B,CAAA;AAE5D,OAAO,EAAE,MAAM,EAAE,MAAM,UAAU,CAAA;AACjC,OAAO,EAAE,gBAAgB,EAAE,UAAU,EAAE,MAAM,oBAAoB,CAAA;AAEjE,MAAM,MAAM,kBAAkB,GAAG,2BAA2B,CAAA;AAC5D,eAAO,MAAM,kBAAkB,EAAE,kBAAgD,CAAA;AAEjF,MAAM,MAAM,mBAAmB,GAAG,MAAM,EAAE,CAAA;AAC1C,MAAM,MAAM,YAAY,GAAG,MAAM,CAAA;AACjC,MAAM,MAAM,aAAa,GAAG,OAAO,GAAG,UAAU,CAAA;AAEhD,MAAM,WAAW,qBAAqB;IACpC,QAAQ,CAAC,SAAS,CAAC,EAAE;QACnB,QAAQ,CAAC,UAAU,CAAC,EAAE,gBAAgB,EAAE,CAAA;KACzC,CAAA;CACF;AAED,MAAM,MAAM,YAAY,CAAC,OAAO,SAAS,WAAW,GAAG,OAAO,GAAG,IAAI,GAAG,IAAI,EAAE,OAAO,SAAS,MAAM,GAAG,IAAI,GAAG,IAAI,IAAI,OAAO,CAC3H,cAAc,CACZ;IACE,sEAAsE;IACtE,QAAQ,CAAC,SAAS,CAAC,EAAE,gBAAgB,CAAA;IAErC;;;;OAIG;IACH,QAAQ,CAAC,MAAM,CAAC,EAAE,MAAM,CAAA;IAExB,gIAAgI;IAChI,QAAQ,CAAC,IAAI,CAAC,EAAE,UAAU,CAAA;IAE1B,yCAAyC;IACzC,QAAQ,CAAC,MAAM,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE;QAAE,IAAI,CAAC,EAAE,MAAM,CAAA;KAAE,CAAC,CAAA;IAEnD,QAAQ,CAAC,KAAK,CAAC,EAAE,WAAW,CAAA;IAE5B,MAAM,EAAE,OAAO,SAAS,OAAO,GAAG,OAAO,CAAC,QAAQ,CAAC,GAAG,kBAAkB,CAAA;IAExE,iMAAiM;IACjM,QAAQ,CAAC,QAAQ,CAAC,EAAE;QAClB,6FAA6F;QAC7F,QAAQ,CAAC,cAAc,CAAC,EAAE,OAAO,CAAA;QAEjC,gFAAgF;QAChF,QAAQ,CAAC,OAAO,CAAC,EAAE,MAAM,CAAC,YAAY,EAAE,CAAC,OAAO,GAAG,mBAAmB,CAAC,EAAE,CAAC,CAAA;QAE1E,sFAAsF;QACtF,QAAQ,CAAC,UAAU,CAAC,EAAE,MAAM,CAAC,YAAY,EAAE,OAAO,EAAE,CAAC,CAAA;KACtD,CAAA;IAED,8BAA8B;IAC9B,QAAQ,CAAC,IAAI,CAAC,EAAE,OAAO,CAAA;IAEvB,8EAA8E;IAC9E,QAAQ,CAAC,YAAY,CAAC,EAAE,OAAO,CAAA;IAE/B,qDAAqD;IACrD,QAAQ,CAAC,SAAS,CAAC,EAAE,OAAO,CAAA;CAC7B,GAAG,qBAAqB,EACzB,OAAO,CACR,EACD,OAAO,CACR,CAAA;AAED,MAAM,MAAM,eAAe,CAAC,OAAO,SAAS,IAAI,CAAC,YAAY,EAAE,QAAQ,CAAC,GAAG;IAAE,MAAM,EAAE,MAAM,CAAA;CAAE,GAAG,IAAI,CAAC,YAAY,EAAE,QAAQ,CAAC,GAAG;IAAE,MAAM,EAAE,MAAM,CAAA;CAAE,IAC/I,YAAY,CAAC,OAAO,EAAE,MAAM,CAAC,CAAA;AAE/B,MAAM,MAAM,oBAAoB,CAAC,OAAO,SAAS,eAAe,CAAC,YAAY,CAAC,GAAG,eAAe,CAAC,YAAY,CAAC,IAAI,IAAI,CAAC,OAAO,EAAE,QAAQ,CAAC,GAAG;IAC1I,MAAM,CAAC,EAAE,OAAO,CAAC,QAAQ,CAAC,CAAA;CAC3B,CAAA;AAED,MAAM,MAAM,eAAe,GAAG,eAAe,CAAC,YAAY,CAAC,CAAA"}

package/src/Config.ts

@@ -1,78 +0,0 @@
-import { Address } from '@xylabs/hex'
-import { EmptyObject, WithAdditional } from '@xylabs/object'
-import { RetryConfig } from '@xylabs/retry'
-import { Payload, Schema } from '@xyo-network/payload-model'
-
-import { Labels } from './Labels'
-import { ModuleIdentifier, ModuleName } from './ModuleIdentifier'
-
-export type ModuleConfigSchema = 'network.xyo.module.config'
-export const ModuleConfigSchema: ModuleConfigSchema = 'network.xyo.module.config'
-
-export type CosigningAddressSet = string[]
-export type SchemaString = string
-export type NameOrAddress = Address | ModuleName
-
-export interface ArchivingModuleConfig {
-  readonly archiving?: {
-    readonly archivists?: ModuleIdentifier[]
-  }
-}
-
-export type ModuleConfig<TConfig extends EmptyObject | Payload | void = void, TSchema extends Schema | void = void> = Payload<
-  WithAdditional<
-    {
-      /** @field The name/address of the Archivist to use for this module */
-      readonly archivist?: ModuleIdentifier
-
-      /**
-       * @field The labels used for this module. If a label is specified, then the
-       * ModuleFactoryLocator will attempt to find a ModuleFactory with the corresponding
-       * labels to construct this module.
-       */
-      readonly labels?: Labels
-
-      /** @field Friendly name of module (not collision resistent). Can be used to resolve module when registered/attached to Node. */
-      readonly name?: ModuleName
-
-      /** @field paging settings for queries */
-      readonly paging?: Record<string, { size?: number }>
-
-      readonly retry?: RetryConfig
-
-      schema: TConfig extends Payload ? TConfig['schema'] : ModuleConfigSchema
-
-      /** @field The query schemas and allowed/disallowed addresses which are allowed to issue them against the module. If both allowed and disallowed is specified, then disallowed takes priority. */
-      readonly security?: {
-        /** @field Will the module process queries that have unsigned BoundWitness in query tuples */
-        readonly allowAnonymous?: boolean
-
-        /** @field If schema in record, then only these address sets can access query */
-        readonly allowed?: Record<SchemaString, (Address | CosigningAddressSet)[]>
-
-        /** @field If schema in record, then anyone except these addresses can access query */
-        readonly disallowed?: Record<SchemaString, Address[]>
-      }
-
-      /** @field sign every query */
-      readonly sign?: boolean
-
-      /** @field Store the queries made to the module in an archivist if possible */
-      readonly storeQueries?: boolean
-
-      /** @field add a timestamp payload to every query  */
-      readonly timestamp?: boolean
-    } & ArchivingModuleConfig,
-    TConfig
-  >,
-  TSchema
->
-
-export type AnyConfigSchema<TConfig extends Omit<ModuleConfig, 'schema'> & { schema: string } = Omit<ModuleConfig, 'schema'> & { schema: string }> =
-  ModuleConfig<TConfig, string>
-
-export type OptionalConfigSchema<TConfig extends AnyConfigSchema<ModuleConfig> = AnyConfigSchema<ModuleConfig>> = Omit<TConfig, 'schema'> & {
-  schema?: TConfig['schema']
-}
-
-export type AnyModuleConfig = AnyConfigSchema<ModuleConfig>