@xyo-network/sentinel-model 3.3.0 → 3.3.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -8,29 +8,44 @@ export declare const SentinelEventAutomationSchema: SentinelEventAutomationSchem
8
8
  export type SentinelBaseAutomationPayload<T extends Payload> = Payload<{
9
9
  type?: 'interval' | 'event';
10
10
  } & T>;
11
+ /** Settings for an Interval Automation */
11
12
  export type SentinelIntervalAutomationPayload = SentinelBaseAutomationPayload<{
13
+ /** Epoch after which any reoccurrence stops */
12
14
  end?: number;
15
+ /** Time between triggers [non-repeating if undefined] */
13
16
  frequency?: number;
17
+ /** Units for frequency field [hour if undefined] */
14
18
  frequencyUnits?: 'second' | 'minute' | 'hour' | 'day';
19
+ /** Remaining triggers [infinite if undefined] */
15
20
  remaining?: number;
16
21
  schema: SentinelIntervalAutomationSchema;
22
+ /** Epoch of the next trigger */
17
23
  start: number;
24
+ /** The type of automation */
18
25
  type: 'interval';
19
26
  }>;
20
27
  export declare const isSentinelIntervalAutomation: (x?: unknown | null) => x is import("@xyo-network/payload-model").SchemaFields & import("@xyo-network/payload-model").PayloadFields & {
21
28
  type?: "interval" | "event";
22
29
  } & {
30
+ /** Epoch after which any reoccurrence stops */
23
31
  end?: number;
32
+ /** Time between triggers [non-repeating if undefined] */
24
33
  frequency?: number;
34
+ /** Units for frequency field [hour if undefined] */
25
35
  frequencyUnits?: "second" | "minute" | "hour" | "day";
36
+ /** Remaining triggers [infinite if undefined] */
26
37
  remaining?: number;
27
38
  schema: SentinelIntervalAutomationSchema;
39
+ /** Epoch of the next trigger */
28
40
  start: number;
41
+ /** The type of automation */
29
42
  type: "interval";
30
43
  };
44
+ /** Settings for an Event Automation */
31
45
  export type SentinelEventAutomationPayload = SentinelBaseAutomationPayload<{
32
46
  schema: SentinelEventAutomationSchema;
33
47
  type: 'event';
34
48
  }>;
49
+ /** Settings for an Automation */
35
50
  export type SentinelAutomationPayload = Payload<SentinelIntervalAutomationPayload | SentinelEventAutomationPayload, SentinelAutomationSchema | SentinelIntervalAutomationSchema | SentinelEventAutomationSchema>;
36
51
  //# sourceMappingURL=Automation.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"Automation.d.ts","sourceRoot":"","sources":["../../src/Automation.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,4BAA4B,CAAA;AAGzD,MAAM,MAAM,wBAAwB,GAAG,wBAAwB,CAAA;AAC/D,eAAO,MAAM,wBAAwB,EAAE,wBAAmD,CAAA;AAE1F,MAAM,MAAM,gCAAgC,GAAG,iCAAiC,CAAA;AAChF,eAAO,MAAM,gCAAgC,EAAE,gCAAoE,CAAA;AAEnH,MAAM,MAAM,6BAA6B,GAAG,8BAA8B,CAAA;AAC1E,eAAO,MAAM,6BAA6B,EAAE,6BAA8D,CAAA;AAE1G,MAAM,MAAM,6BAA6B,CAAC,CAAC,SAAS,OAAO,IAAI,OAAO,CACpE;IACE,IAAI,CAAC,EAAE,UAAU,GAAG,OAAO,CAAA;CAC5B,GAAG,CAAC,CACN,CAAA;AAGD,MAAM,MAAM,iCAAiC,GAAG,6BAA6B,CAAC;IAE5E,GAAG,CAAC,EAAE,MAAM,CAAA;IAGZ,SAAS,CAAC,EAAE,MAAM,CAAA;IAGlB,cAAc,CAAC,EAAE,QAAQ,GAAG,QAAQ,GAAG,MAAM,GAAG,KAAK,CAAA;IAGrD,SAAS,CAAC,EAAE,MAAM,CAAA;IAElB,MAAM,EAAE,gCAAgC,CAAA;IAGxC,KAAK,EAAE,MAAM,CAAA;IAGb,IAAI,EAAE,UAAU,CAAA;CACjB,CAAC,CAAA;AAEF,eAAO,MAAM,4BAA4B;WA3B9B,UAAU,GAAG,OAAO;;UAOvB,MAAM;gBAGA,MAAM;qBAGD,QAAQ,GAAG,QAAQ,GAAG,MAAM,GAAG,KAAK;gBAGzC,MAAM;YAEV,gCAAgC;WAGjC,MAAM;UAGP,UAAU;CAGoH,CAAA;AAGtI,MAAM,MAAM,8BAA8B,GAAG,6BAA6B,CAAC;IACzE,MAAM,EAAE,6BAA6B,CAAA;IACrC,IAAI,EAAE,OAAO,CAAA;CACd,CAAC,CAAA;AAGF,MAAM,MAAM,yBAAyB,GAAG,OAAO,CAC7C,iCAAiC,GAAG,8BAA8B,EAClE,wBAAwB,GAAG,gCAAgC,GAAG,6BAA6B,CAC5F,CAAA"}
1
+ {"version":3,"file":"Automation.d.ts","sourceRoot":"","sources":["../../src/Automation.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,4BAA4B,CAAA;AAGzD,MAAM,MAAM,wBAAwB,GAAG,wBAAwB,CAAA;AAC/D,eAAO,MAAM,wBAAwB,EAAE,wBAAmD,CAAA;AAE1F,MAAM,MAAM,gCAAgC,GAAG,iCAAiC,CAAA;AAChF,eAAO,MAAM,gCAAgC,EAAE,gCAAoE,CAAA;AAEnH,MAAM,MAAM,6BAA6B,GAAG,8BAA8B,CAAA;AAC1E,eAAO,MAAM,6BAA6B,EAAE,6BAA8D,CAAA;AAE1G,MAAM,MAAM,6BAA6B,CAAC,CAAC,SAAS,OAAO,IAAI,OAAO,CACpE;IACE,IAAI,CAAC,EAAE,UAAU,GAAG,OAAO,CAAA;CAC5B,GAAG,CAAC,CACN,CAAA;AAED,0CAA0C;AAC1C,MAAM,MAAM,iCAAiC,GAAG,6BAA6B,CAAC;IAC5E,+CAA+C;IAC/C,GAAG,CAAC,EAAE,MAAM,CAAA;IAEZ,yDAAyD;IACzD,SAAS,CAAC,EAAE,MAAM,CAAA;IAElB,oDAAoD;IACpD,cAAc,CAAC,EAAE,QAAQ,GAAG,QAAQ,GAAG,MAAM,GAAG,KAAK,CAAA;IAErD,iDAAiD;IACjD,SAAS,CAAC,EAAE,MAAM,CAAA;IAElB,MAAM,EAAE,gCAAgC,CAAA;IAExC,gCAAgC;IAChC,KAAK,EAAE,MAAM,CAAA;IAEb,6BAA6B;IAC7B,IAAI,EAAE,UAAU,CAAA;CACjB,CAAC,CAAA;AAEF,eAAO,MAAM,4BAA4B;WA3B9B,UAAU,GAAG,OAAO;;IAM7B,+CAA+C;UACzC,MAAM;IAEZ,yDAAyD;gBAC7C,MAAM;IAElB,oDAAoD;qBACnC,QAAQ,GAAG,QAAQ,GAAG,MAAM,GAAG,KAAK;IAErD,iDAAiD;gBACrC,MAAM;YAEV,gCAAgC;IAExC,gCAAgC;WACzB,MAAM;IAEb,6BAA6B;UACvB,UAAU;CAGoH,CAAA;AAEtI,uCAAuC;AACvC,MAAM,MAAM,8BAA8B,GAAG,6BAA6B,CAAC;IACzE,MAAM,EAAE,6BAA6B,CAAA;IACrC,IAAI,EAAE,OAAO,CAAA;CACd,CAAC,CAAA;AAEF,iCAAiC;AACjC,MAAM,MAAM,yBAAyB,GAAG,OAAO,CAC7C,iCAAiC,GAAG,8BAA8B,EAClE,wBAAwB,GAAG,gCAAgC,GAAG,6BAA6B,CAC5F,CAAA"}
@@ -4,6 +4,7 @@ import type { ModuleInstance } from '@xyo-network/module-model';
4
4
  import type { WitnessInstance } from '@xyo-network/witness-model';
5
5
  import type { ArchivistTask, DivinerTask, ModuleTask, WitnessTask } from './Task.ts';
6
6
  export type ResolvedModuleTask<TTask extends ModuleTask = ModuleTask, TInstance extends ModuleInstance = ModuleInstance> = Omit<TTask, 'mod'> & {
7
+ /** @field the modules that performs the task */
7
8
  mod: TInstance;
8
9
  };
9
10
  export type ResolvedArchivistTask = ResolvedModuleTask<ArchivistTask, ArchivistInstance>;
@@ -1 +1 @@
1
- {"version":3,"file":"ResolvedTask.d.ts","sourceRoot":"","sources":["../../src/ResolvedTask.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,8BAA8B,CAAA;AACrE,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,4BAA4B,CAAA;AACjE,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,2BAA2B,CAAA;AAC/D,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,4BAA4B,CAAA;AAEjE,OAAO,KAAK,EACV,aAAa,EAAE,WAAW,EAAE,UAAU,EAAE,WAAW,EACpD,MAAM,WAAW,CAAA;AAElB,MAAM,MAAM,kBAAkB,CAAC,KAAK,SAAS,UAAU,GAAG,UAAU,EAAE,SAAS,SAAS,cAAc,GAAG,cAAc,IAAI,IAAI,CAAC,KAAK,EAAE,KAAK,CAAC,GAAG;IAE9I,GAAG,EAAE,SAAS,CAAA;CACf,CAAA;AAED,MAAM,MAAM,qBAAqB,GAAG,kBAAkB,CAAC,aAAa,EAAE,iBAAiB,CAAC,CAAA;AACxF,MAAM,MAAM,mBAAmB,GAAG,kBAAkB,CAAC,WAAW,EAAE,eAAe,CAAC,CAAA;AAClF,MAAM,MAAM,mBAAmB,GAAG,kBAAkB,CAAC,WAAW,EAAE,eAAe,CAAC,CAAA;AAElF,MAAM,MAAM,YAAY,GAAG,qBAAqB,GAAG,mBAAmB,GAAG,mBAAmB,GAAG,kBAAkB,CAAA"}
1
+ {"version":3,"file":"ResolvedTask.d.ts","sourceRoot":"","sources":["../../src/ResolvedTask.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,8BAA8B,CAAA;AACrE,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,4BAA4B,CAAA;AACjE,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,2BAA2B,CAAA;AAC/D,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,4BAA4B,CAAA;AAEjE,OAAO,KAAK,EACV,aAAa,EAAE,WAAW,EAAE,UAAU,EAAE,WAAW,EACpD,MAAM,WAAW,CAAA;AAElB,MAAM,MAAM,kBAAkB,CAAC,KAAK,SAAS,UAAU,GAAG,UAAU,EAAE,SAAS,SAAS,cAAc,GAAG,cAAc,IAAI,IAAI,CAAC,KAAK,EAAE,KAAK,CAAC,GAAG;IAC9I,gDAAgD;IAChD,GAAG,EAAE,SAAS,CAAA;CACf,CAAA;AAED,MAAM,MAAM,qBAAqB,GAAG,kBAAkB,CAAC,aAAa,EAAE,iBAAiB,CAAC,CAAA;AACxF,MAAM,MAAM,mBAAmB,GAAG,kBAAkB,CAAC,WAAW,EAAE,eAAe,CAAC,CAAA;AAClF,MAAM,MAAM,mBAAmB,GAAG,kBAAkB,CAAC,WAAW,EAAE,eAAe,CAAC,CAAA;AAElF,MAAM,MAAM,YAAY,GAAG,qBAAqB,GAAG,mBAAmB,GAAG,mBAAmB,GAAG,kBAAkB,CAAA"}
@@ -1,7 +1,10 @@
1
1
  import type { ModuleIdentifier } from '@xyo-network/module-model';
2
2
  export interface ModuleTask<TEndpoints extends string = string> {
3
+ /** @field the name of the endPoint that is being called. If not specified, the default endPoint is used */
3
4
  endPoint?: TEndpoints;
5
+ /** @field determines what inputs are sent to each module - if string, that is the output from other module (name/address) */
4
6
  input?: boolean | ModuleIdentifier | ModuleIdentifier[];
7
+ /** @field the modules that performs the task */
5
8
  mod: ModuleIdentifier;
6
9
  required?: boolean;
7
10
  }
@@ -1 +1 @@
1
- {"version":3,"file":"Task.d.ts","sourceRoot":"","sources":["../../src/Task.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,2BAA2B,CAAA;AAEjE,MAAM,WAAW,UAAU,CAAC,UAAU,SAAS,MAAM,GAAG,MAAM;IAE5D,QAAQ,CAAC,EAAE,UAAU,CAAA;IAErB,KAAK,CAAC,EAAE,OAAO,GAAG,gBAAgB,GAAG,gBAAgB,EAAE,CAAA;IAEvD,GAAG,EAAE,gBAAgB,CAAA;IACrB,QAAQ,CAAC,EAAE,OAAO,CAAA;CACnB;AAED,MAAM,MAAM,aAAa,GAAG,UAAU,CAAC,KAAK,GAAG,OAAO,GAAG,QAAQ,GAAG,QAAQ,GAAG,KAAK,GAAG,QAAQ,CAAC,CAAA;AAChG,MAAM,MAAM,WAAW,GAAG,UAAU,CAAC,QAAQ,CAAC,CAAA;AAC9C,MAAM,MAAM,WAAW,GAAG,UAAU,CAAC,SAAS,CAAC,CAAA;AAE/C,MAAM,MAAM,IAAI,GAAG,WAAW,GAAG,WAAW,GAAG,aAAa,GAAG,UAAU,CAAA"}
1
+ {"version":3,"file":"Task.d.ts","sourceRoot":"","sources":["../../src/Task.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,2BAA2B,CAAA;AAEjE,MAAM,WAAW,UAAU,CAAC,UAAU,SAAS,MAAM,GAAG,MAAM;IAC5D,4GAA4G;IAC5G,QAAQ,CAAC,EAAE,UAAU,CAAA;IACrB,6HAA6H;IAC7H,KAAK,CAAC,EAAE,OAAO,GAAG,gBAAgB,GAAG,gBAAgB,EAAE,CAAA;IACvD,gDAAgD;IAChD,GAAG,EAAE,gBAAgB,CAAA;IACrB,QAAQ,CAAC,EAAE,OAAO,CAAA;CACnB;AAED,MAAM,MAAM,aAAa,GAAG,UAAU,CAAC,KAAK,GAAG,OAAO,GAAG,QAAQ,GAAG,QAAQ,GAAG,KAAK,GAAG,QAAQ,CAAC,CAAA;AAChG,MAAM,MAAM,WAAW,GAAG,UAAU,CAAC,QAAQ,CAAC,CAAA;AAC9C,MAAM,MAAM,WAAW,GAAG,UAAU,CAAC,SAAS,CAAC,CAAA;AAE/C,MAAM,MAAM,IAAI,GAAG,WAAW,GAAG,WAAW,GAAG,aAAa,GAAG,UAAU,CAAA"}
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@xyo-network/sentinel-model",
3
- "version": "3.3.0",
3
+ "version": "3.3.2",
4
4
  "description": "Primary SDK for using XYO Protocol 2.0",
5
5
  "homepage": "https://xyo.network",
6
6
  "bugs": {
@@ -29,21 +29,21 @@
29
29
  "module": "dist/neutral/index.mjs",
30
30
  "types": "dist/neutral/index.d.ts",
31
31
  "dependencies": {
32
- "@xylabs/hex": "^4.2.2",
33
- "@xylabs/object": "^4.2.2",
34
- "@xylabs/promise": "^4.2.2",
35
- "@xyo-network/account-model": "^3.3.0",
36
- "@xyo-network/archivist-model": "^3.3.0",
37
- "@xyo-network/boundwitness-model": "^3.3.0",
38
- "@xyo-network/diviner-model": "^3.3.0",
39
- "@xyo-network/module-events": "^3.3.0",
40
- "@xyo-network/module-model": "^3.3.0",
41
- "@xyo-network/payload-model": "^3.3.0",
42
- "@xyo-network/witness-model": "^3.3.0"
32
+ "@xylabs/hex": "^4.3.2",
33
+ "@xylabs/object": "^4.3.2",
34
+ "@xylabs/promise": "^4.3.2",
35
+ "@xyo-network/account-model": "^3.3.2",
36
+ "@xyo-network/archivist-model": "^3.3.2",
37
+ "@xyo-network/boundwitness-model": "^3.3.2",
38
+ "@xyo-network/diviner-model": "^3.3.2",
39
+ "@xyo-network/module-events": "^3.3.2",
40
+ "@xyo-network/module-model": "^3.3.2",
41
+ "@xyo-network/payload-model": "^3.3.2",
42
+ "@xyo-network/witness-model": "^3.3.2"
43
43
  },
44
44
  "devDependencies": {
45
- "@xylabs/ts-scripts-yarn3": "^4.2.1",
46
- "@xylabs/tsconfig": "^4.2.1",
45
+ "@xylabs/ts-scripts-yarn3": "^4.2.3",
46
+ "@xylabs/tsconfig": "^4.2.3",
47
47
  "typescript": "^5.6.3"
48
48
  },
49
49
  "publishConfig": {