@xyo-network/module-model 2.90.22 → 2.91.0

package/dist/node/withModule.d.cts

@@ -15,8 +15,8 @@ export declare const withModule: <R>(module: any, closure: (module: import("./mo
         schema: "network.xyo.module.config";
         readonly security?: {
             readonly allowAnonymous?: boolean | undefined;
-            readonly allowed?: Record<string, (string | import("./Config").CosigningAddressSet)[]> | undefined;
-            readonly disallowed?: Record<string, string[]> | undefined;
+            readonly allowed?: Record<string, (Lowercase<string> | import("./Config").CosigningAddressSet)[]> | undefined;
+            readonly disallowed?: Record<string, Lowercase<string>[]> | undefined;
         } | undefined;
         readonly sign?: boolean | undefined;
         readonly storeQueries?: boolean | undefined;
@@ -32,8 +32,8 @@ export declare const withModule: <R>(module: any, closure: (module: import("./mo
         schema: "network.xyo.module.config";
         readonly security?: {
             readonly allowAnonymous?: boolean | undefined;
-            readonly allowed?: Record<string, (string | import("./Config").CosigningAddressSet)[]> | undefined;
-            readonly disallowed?: Record<string, string[]> | undefined;
+            readonly allowed?: Record<string, (Lowercase<string> | import("./Config").CosigningAddressSet)[]> | undefined;
+            readonly disallowed?: Record<string, Lowercase<string>[]> | undefined;
         } | undefined;
         readonly sign?: boolean | undefined;
         readonly storeQueries?: boolean | undefined;
@@ -56,8 +56,8 @@ export declare const withModuleInstance: <R>(module: any, closure: (module: impo
         schema: "network.xyo.module.config";
         readonly security?: {
             readonly allowAnonymous?: boolean | undefined;
-            readonly allowed?: Record<string, (string | import("./Config").CosigningAddressSet)[]> | undefined;
-            readonly disallowed?: Record<string, string[]> | undefined;
+            readonly allowed?: Record<string, (Lowercase<string> | import("./Config").CosigningAddressSet)[]> | undefined;
+            readonly disallowed?: Record<string, Lowercase<string>[]> | undefined;
         } | undefined;
         readonly sign?: boolean | undefined;
         readonly storeQueries?: boolean | undefined;
@@ -73,8 +73,8 @@ export declare const withModuleInstance: <R>(module: any, closure: (module: impo
         schema: "network.xyo.module.config";
         readonly security?: {
             readonly allowAnonymous?: boolean | undefined;
-            readonly allowed?: Record<string, (string | import("./Config").CosigningAddressSet)[]> | undefined;
-            readonly disallowed?: Record<string, string[]> | undefined;
+            readonly allowed?: Record<string, (Lowercase<string> | import("./Config").CosigningAddressSet)[]> | undefined;
+            readonly disallowed?: Record<string, Lowercase<string>[]> | undefined;
         } | undefined;
         readonly sign?: boolean | undefined;
         readonly storeQueries?: boolean | undefined;

package/dist/node/withModule.d.mts

@@ -15,8 +15,8 @@ export declare const withModule: <R>(module: any, closure: (module: import("./mo
         schema: "network.xyo.module.config";
         readonly security?: {
             readonly allowAnonymous?: boolean | undefined;
-            readonly allowed?: Record<string, (string | import("./Config").CosigningAddressSet)[]> | undefined;
-            readonly disallowed?: Record<string, string[]> | undefined;
+            readonly allowed?: Record<string, (Lowercase<string> | import("./Config").CosigningAddressSet)[]> | undefined;
+            readonly disallowed?: Record<string, Lowercase<string>[]> | undefined;
         } | undefined;
         readonly sign?: boolean | undefined;
         readonly storeQueries?: boolean | undefined;
@@ -32,8 +32,8 @@ export declare const withModule: <R>(module: any, closure: (module: import("./mo
         schema: "network.xyo.module.config";
         readonly security?: {
             readonly allowAnonymous?: boolean | undefined;
-            readonly allowed?: Record<string, (string | import("./Config").CosigningAddressSet)[]> | undefined;
-            readonly disallowed?: Record<string, string[]> | undefined;
+            readonly allowed?: Record<string, (Lowercase<string> | import("./Config").CosigningAddressSet)[]> | undefined;
+            readonly disallowed?: Record<string, Lowercase<string>[]> | undefined;
         } | undefined;
         readonly sign?: boolean | undefined;
         readonly storeQueries?: boolean | undefined;
@@ -56,8 +56,8 @@ export declare const withModuleInstance: <R>(module: any, closure: (module: impo
         schema: "network.xyo.module.config";
         readonly security?: {
             readonly allowAnonymous?: boolean | undefined;
-            readonly allowed?: Record<string, (string | import("./Config").CosigningAddressSet)[]> | undefined;
-            readonly disallowed?: Record<string, string[]> | undefined;
+            readonly allowed?: Record<string, (Lowercase<string> | import("./Config").CosigningAddressSet)[]> | undefined;
+            readonly disallowed?: Record<string, Lowercase<string>[]> | undefined;
         } | undefined;
         readonly sign?: boolean | undefined;
         readonly storeQueries?: boolean | undefined;
@@ -73,8 +73,8 @@ export declare const withModuleInstance: <R>(module: any, closure: (module: impo
         schema: "network.xyo.module.config";
         readonly security?: {
             readonly allowAnonymous?: boolean | undefined;
-            readonly allowed?: Record<string, (string | import("./Config").CosigningAddressSet)[]> | undefined;
-            readonly disallowed?: Record<string, string[]> | undefined;
+            readonly allowed?: Record<string, (Lowercase<string> | import("./Config").CosigningAddressSet)[]> | undefined;
+            readonly disallowed?: Record<string, Lowercase<string>[]> | undefined;
         } | undefined;
         readonly sign?: boolean | undefined;
         readonly storeQueries?: boolean | undefined;

package/dist/node/withModule.d.ts

@@ -15,8 +15,8 @@ export declare const withModule: <R>(module: any, closure: (module: import("./mo
         schema: "network.xyo.module.config";
         readonly security?: {
             readonly allowAnonymous?: boolean | undefined;
-            readonly allowed?: Record<string, (string | import("./Config").CosigningAddressSet)[]> | undefined;
-            readonly disallowed?: Record<string, string[]> | undefined;
+            readonly allowed?: Record<string, (Lowercase<string> | import("./Config").CosigningAddressSet)[]> | undefined;
+            readonly disallowed?: Record<string, Lowercase<string>[]> | undefined;
         } | undefined;
         readonly sign?: boolean | undefined;
         readonly storeQueries?: boolean | undefined;
@@ -32,8 +32,8 @@ export declare const withModule: <R>(module: any, closure: (module: import("./mo
         schema: "network.xyo.module.config";
         readonly security?: {
             readonly allowAnonymous?: boolean | undefined;
-            readonly allowed?: Record<string, (string | import("./Config").CosigningAddressSet)[]> | undefined;
-            readonly disallowed?: Record<string, string[]> | undefined;
+            readonly allowed?: Record<string, (Lowercase<string> | import("./Config").CosigningAddressSet)[]> | undefined;
+            readonly disallowed?: Record<string, Lowercase<string>[]> | undefined;
         } | undefined;
         readonly sign?: boolean | undefined;
         readonly storeQueries?: boolean | undefined;
@@ -56,8 +56,8 @@ export declare const withModuleInstance: <R>(module: any, closure: (module: impo
         schema: "network.xyo.module.config";
         readonly security?: {
             readonly allowAnonymous?: boolean | undefined;
-            readonly allowed?: Record<string, (string | import("./Config").CosigningAddressSet)[]> | undefined;
-            readonly disallowed?: Record<string, string[]> | undefined;
+            readonly allowed?: Record<string, (Lowercase<string> | import("./Config").CosigningAddressSet)[]> | undefined;
+            readonly disallowed?: Record<string, Lowercase<string>[]> | undefined;
         } | undefined;
         readonly sign?: boolean | undefined;
         readonly storeQueries?: boolean | undefined;
@@ -73,8 +73,8 @@ export declare const withModuleInstance: <R>(module: any, closure: (module: impo
         schema: "network.xyo.module.config";
         readonly security?: {
             readonly allowAnonymous?: boolean | undefined;
-            readonly allowed?: Record<string, (string | import("./Config").CosigningAddressSet)[]> | undefined;
-            readonly disallowed?: Record<string, string[]> | undefined;
+            readonly allowed?: Record<string, (Lowercase<string> | import("./Config").CosigningAddressSet)[]> | undefined;
+            readonly disallowed?: Record<string, Lowercase<string>[]> | undefined;
         } | undefined;
         readonly sign?: boolean | undefined;
         readonly storeQueries?: boolean | undefined;

package/package.json

@@ -10,23 +10,23 @@
     "url": "https://github.com/XYOracleNetwork/sdk-xyo-client-js/issues"
   },
   "dependencies": {
-    "@xylabs/assert": "^2.14.2",
-    "@xylabs/hex": "^2.14.2",
-    "@xylabs/lodash": "^2.14.2",
-    "@xylabs/logger": "^2.14.2",
-    "@xylabs/object": "^2.89.2",
-    "@xylabs/promise": "^2.14.2",
-    "@xylabs/retry": "^2.14.2",
-    "@xyo-network/account-model": "~2.90.22",
-    "@xyo-network/address-payload-plugin": "~2.90.22",
-    "@xyo-network/boundwitness-model": "~2.90.22",
-    "@xyo-network/manifest-model": "~2.90.22",
-    "@xyo-network/module-events": "~2.90.22",
-    "@xyo-network/payload-model": "~2.90.22"
+    "@xylabs/assert": "^3.0.0",
+    "@xylabs/hex": "^3.0.0",
+    "@xylabs/lodash": "^3.0.0",
+    "@xylabs/logger": "^3.0.0",
+    "@xylabs/object": "^3.0.0",
+    "@xylabs/promise": "^3.0.0",
+    "@xylabs/retry": "^3.0.0",
+    "@xyo-network/account-model": "~2.91.0",
+    "@xyo-network/address-payload-plugin": "~2.91.0",
+    "@xyo-network/boundwitness-model": "~2.91.0",
+    "@xyo-network/manifest-model": "~2.91.0",
+    "@xyo-network/module-events": "~2.91.0",
+    "@xyo-network/payload-model": "~2.91.0"
   },
   "devDependencies": {
-    "@xylabs/ts-scripts-yarn3": "^3.2.42",
-    "@xylabs/tsconfig": "^3.2.42",
+    "@xylabs/ts-scripts-yarn3": "^3.4.1",
+    "@xylabs/tsconfig": "^3.4.1",
     "typescript": "^5.3.3"
   },
   "description": "Primary SDK for using XYO Protocol 2.0",
@@ -68,6 +68,6 @@
     "url": "https://github.com/XYOracleNetwork/sdk-xyo-client-js.git"
   },
   "sideEffects": false,
-  "version": "2.90.22",
+  "version": "2.91.0",
   "type": "module"
 }

package/src/Config.ts

@@ -3,6 +3,7 @@ import { EmptyObject, WithAdditional } from '@xylabs/object'
 import { RetryConfig } from '@xylabs/retry'
 import { Payload, Schema } from '@xyo-network/payload-model'
 
+import { ModuleIdentifier, ModuleName } from './instance'
 import { Labels } from './Labels'
 
 export type ModuleConfigSchema = 'network.xyo.module.config'
@@ -10,12 +11,11 @@ export const ModuleConfigSchema: ModuleConfigSchema = 'network.xyo.module.config
 
 export type CosigningAddressSet = string[]
 export type SchemaString = string
-export type ModuleName = string
 export type NameOrAddress = Address | ModuleName
 
 export interface ArchivingModuleConfig {
   readonly archiving?: {
-    readonly archivists?: NameOrAddress[]
+    readonly archivists?: ModuleIdentifier[]
   }
 }
 
@@ -23,7 +23,7 @@ export type ModuleConfig<TConfig extends EmptyObject | Payload | void = void, TS
   WithAdditional<
     {
       /** @field The name/address of the Archivist to use for this module */
-      readonly archivist?: NameOrAddress
+      readonly archivist?: ModuleIdentifier
 
       /**
        * @field The labels used for this module. If a label is specified, then the
@@ -33,7 +33,7 @@ export type ModuleConfig<TConfig extends EmptyObject | Payload | void = void, TS
       readonly labels?: Labels
 
       /** @field Friendly name of module (not collision resistent). Can be used to resolve module when registered/attached to Node. */
-      readonly name?: string
+      readonly name?: ModuleName
 
       /** @field paging settings for queries */
       readonly paging?: Record<string, { size?: number }>

package/src/CreatableModule/ModuleFactoryLocator.ts

@@ -75,8 +75,8 @@ export class ModuleFactoryLocator {
    */
   tryLocate(schema: string, labels?: Labels): CreatableModuleFactory | LabeledCreatableModuleFactory | undefined {
     // If labels were provided
-    return labels
-      ? // Find the first factory that has labels and has all the labels provided
+    return labels ?
+        // Find the first factory that has labels and has all the labels provided
         this._registry[schema]?.filter(hasLabels).find((factory) => hasAllLabels(factory?.labels, labels))
       : // Otherwise, return the first factory
         this._registry[schema]?.[0]

package/src/EventsModels/ModuleEventArgs.ts

@@ -1,7 +1,8 @@
 import { EventArgs } from '@xyo-network/module-events'
 
-export type ModuleEventArgs<TModule extends object = object, TArgs extends EventArgs | undefined = undefined> = TArgs extends EventArgs
-  ? {
+export type ModuleEventArgs<TModule extends object = object, TArgs extends EventArgs | undefined = undefined> =
+  TArgs extends EventArgs ?
+    {
       module: TModule
     } & TArgs
   : {

package/src/ModuleDescription.ts

@@ -1,6 +1,9 @@
+import { Address } from '@xylabs/hex'
+
+import { ModuleName } from './instance'
 export interface ModuleDescription {
-  address: string
+  address: Address
   children?: string[]
-  name?: string
+  name?: ModuleName
   queries: string[]
 }

package/src/Queries/ModuleAddress/Payload.ts

@@ -1,3 +1,4 @@
+import { Address } from '@xylabs/hex'
 import { AddressSchema } from '@xyo-network/address-payload-plugin'
 import { Payload } from '@xyo-network/payload-model'
 
@@ -5,7 +6,7 @@ export const AddressPreviousHashSchema = `${AddressSchema}.hash.previous`
 export type AddressPreviousHashSchema = typeof AddressPreviousHashSchema
 
 export type AddressPreviousHashPayload = Payload<{
-  address: string
+  address: Address
   previousHash?: string
   schema: AddressPreviousHashSchema
 }>

package/src/Queries/Subscribe.ts

@@ -1,3 +1,4 @@
+import { Address } from '@xylabs/hex'
 import { Query } from '@xyo-network/payload-model'
 
 export type ModuleSubscribeQuerySchema = 'network.xyo.query.module.subscribe'
@@ -11,7 +12,7 @@ export interface ModuleSubscribeFilter {
 //requests notification when a boundwitness is added to the modules chain that meets the filter criteria
 export type ModuleSubscribeQuery = Query<{
   /** @field The address that will receive notifications */
-  address: string
+  address: Address
   /** @field A subscribe with a null for filter is an unsubscribe */
   filter?: ModuleSubscribeFilter | null
   /** @field The maximum events queued per send [may increase frequency] */

package/src/instance/ModuleInstance.ts

@@ -1,3 +1,4 @@
+import { Address } from '@xylabs/hex'
 import { IsObjectFactory, TypeCheck } from '@xylabs/object'
 import { Promisable } from '@xylabs/promise'
 
@@ -5,7 +6,32 @@ import { ModuleEventData } from '../EventsModels'
 import { Module, ModuleQueryFunctions } from '../module'
 import { ModuleParams } from '../ModuleParams'
 
-export type ModulePipeLine = 'one-to-one' | 'one-to-many' | 'many-to-one' | 'many-to-many'
+export type ModulePipeLine = Lowercase<'one-to-one' | 'one-to-many' | 'many-to-one' | 'many-to-many'>
+
+export type ModuleName = string //Capitalize<string>
+
+export type ModuleIdentifier = Address | ModuleName
+
+export type ModuleIdentifierPart = Lowercase<string>
+
+export type ReservedModuleIdentifierCharacter = ':'
+export const ReservedModuleIdentifierCharacters = new Set<ReservedModuleIdentifierCharacter>([':'])
+
+export const isReservedModuleIdentifierCharacter = (value: unknown): value is ReservedModuleIdentifierCharacter => {
+  return typeof value === 'string' && value.length === 1 && ReservedModuleIdentifierCharacters.has(value as ReservedModuleIdentifierCharacter)
+}
+
+export const isModuleIdentifierPart = (value: unknown, falseAction: 'throw' | 'none' = 'none'): value is ModuleIdentifierPart => {
+  const result = typeof value === 'string' && ![...value].some(isReservedModuleIdentifierCharacter)
+  switch (falseAction) {
+    case 'throw': {
+      throw new Error(`Invalid ModuleIdentifierPart: ${value}`)
+    }
+    default: {
+      return result
+    }
+  }
+}
 
 export const isModuleResolver = (value?: unknown): value is ModuleResolver => {
   return typeof (value as Partial<ModuleResolver>).resolve === 'function'
@@ -13,9 +39,9 @@ export const isModuleResolver = (value?: unknown): value is ModuleResolver => {
 
 export interface ModuleResolver {
   resolve<T extends ModuleInstance = ModuleInstance>(filter?: ModuleFilter<T>, options?: ModuleFilterOptions<T>): Promisable<T[]>
-  resolve<T extends ModuleInstance = ModuleInstance>(nameOrAddress: string, options?: ModuleFilterOptions<T>): Promisable<T | undefined>
+  resolve<T extends ModuleInstance = ModuleInstance>(nameOrAddress: ModuleIdentifier, options?: ModuleFilterOptions<T>): Promisable<T | undefined>
   resolve<T extends ModuleInstance = ModuleInstance>(
-    nameOrAddressOrFilter?: ModuleFilter<T> | string,
+    nameOrAddressOrFilter?: ModuleFilter<T> | ModuleIdentifier,
     options?: ModuleFilterOptions<T>,
   ): Promisable<T | T[] | undefined>
 }
@@ -43,25 +69,34 @@ export type InstanceTypeCheck<T extends ModuleInstance = ModuleInstance> = TypeC
 
 export class IsInstanceFactory<T extends ModuleInstance = ModuleInstance> extends IsObjectFactory<T> {}
 
+export type Direction = 'up' | 'down' | 'all'
+export type Visibility = 'public' | 'private' | 'all'
+
 export interface ModuleFilterOptions<T extends ModuleInstance = ModuleInstance> {
-  direction?: 'up' | 'down' | 'all'
+  direction?: Direction
   identity?: InstanceTypeCheck<T>
   maxDepth?: number
-  visibility?: 'public' | 'private' | 'all'
+  visibility?: Visibility
 }
 
 export interface AddressModuleFilter<T extends ModuleInstance = ModuleInstance> extends ModuleFilterOptions<T> {
-  address: string[]
+  address: Address[]
 }
 
+export const isAddressModuleFilter = (value: unknown): value is AddressModuleFilter => (value as AddressModuleFilter).address !== undefined
+
 export interface NameModuleFilter<T extends ModuleInstance = ModuleInstance> extends ModuleFilterOptions<T> {
   name: string[]
 }
 
+export const isNameModuleFilter = (value: unknown): value is NameModuleFilter => (value as NameModuleFilter).name !== undefined
+
 export interface QueryModuleFilter<T extends ModuleInstance = ModuleInstance> extends ModuleFilterOptions<T> {
   query: string[][]
 }
 
+export const isQueryModuleFilter = (value: unknown): value is QueryModuleFilter => (value as QueryModuleFilter).query !== undefined
+
 export type AnyModuleFilter<T extends ModuleInstance = ModuleInstance> = Partial<AddressModuleFilter<T>> &
   Partial<NameModuleFilter<T>> &
   Partial<QueryModuleFilter<T>>

package/src/instance/ModuleRepository.ts

@@ -1,3 +1,5 @@
+import { Address } from '@xylabs/hex'
+
 import { Module } from '../module'
 import { ModuleResolverInstance } from './ModuleInstance'
 
@@ -6,5 +8,5 @@ export interface ModuleRepository extends ModuleResolverInstance {
   add(module: Module[]): this
   add(module: Module | Module[]): this
 
-  remove(address: string | string[]): this
+  remove(address: Address | string[]): this
 }

package/src/module/ModuleFields.ts

@@ -1,3 +1,4 @@
+import { Address } from '@xylabs/hex'
 import { Promisable } from '@xylabs/promise'
 import { QueryBoundWitness } from '@xyo-network/boundwitness-model'
 import { Payload } from '@xyo-network/payload-model'
@@ -7,7 +8,7 @@ import { ModuleParams } from '../ModuleParams'
 import { ModuleQueryResult } from '../ModuleQueryResult'
 
 export type ModuleFields<TParams extends ModuleParams = ModuleParams> = {
-  address: string
+  address: Address
   config: TParams['config']
 
   /** The name (if specified) or address of the module */