@junobuild/functions 0.0.6 → 0.0.7

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.
Files changed (38) hide show
  1. package/README.md +224 -107
  2. package/chunk-OVO3T2DM.js +2 -0
  3. package/chunk-OVO3T2DM.js.map +7 -0
  4. package/global.d.js +1 -0
  5. package/global.d.js.map +7 -0
  6. package/global.d.ts +17 -0
  7. package/{dist/types/configs → hooks/db}/assertions.d.ts +13 -13
  8. package/{dist/types/configs → hooks/db}/hooks.d.ts +13 -13
  9. package/{dist/types/configs/collections.config.d.ts → hooks/schemas/collections.d.ts} +3 -3
  10. package/hooks/schemas/context.d.ts +56 -0
  11. package/{dist/types/hooks → hooks/schemas/db}/context.d.ts +8 -76
  12. package/{dist/types/hooks/datastore.d.ts → hooks/schemas/db/payload.d.ts} +0 -145
  13. package/ic-cdk/id.d.ts +11 -0
  14. package/ic-cdk.d.ts +1 -0
  15. package/ic-cdk.js +7 -0
  16. package/ic-cdk.js.map +7 -0
  17. package/index.d.ts +10 -0
  18. package/index.js +2 -0
  19. package/index.js.map +7 -0
  20. package/package.json +22 -13
  21. package/schemas/candid.d.ts +11 -0
  22. package/{dist/types/hooks → schemas}/core.d.ts +16 -10
  23. package/schemas/db.d.ts +57 -0
  24. package/sdk/db.sdk.d.ts +13 -0
  25. package/sdk/schemas/db.d.ts +109 -0
  26. package/sdk/serializer.sdk.d.ts +17 -0
  27. package/sdk.d.ts +3 -0
  28. package/sdk.js +2 -0
  29. package/sdk.js.map +7 -0
  30. package/src/global.d.ts +17 -0
  31. package/dist/browser/index.js +0 -2
  32. package/dist/browser/index.js.map +0 -7
  33. package/dist/index.js +0 -1
  34. package/dist/types/global.d.ts +0 -8
  35. package/dist/types/index.d.ts +0 -9
  36. package/dist/types/sdk/datastore.sdk.d.ts +0 -3
  37. /package/{dist/types/configs → hooks/schemas}/satellite.env.d.ts +0 -0
  38. /package/{dist/types/polyfills → polyfills}/console.polyfill.d.ts +0 -0
@@ -0,0 +1,109 @@
1
+ import * as z from 'zod';
2
+ /**
3
+ * @see SetDoc
4
+ */
5
+ export declare const SetDocSchema: z.ZodObject<{
6
+ /**
7
+ * The unique key identifying the document within the collection.
8
+ */
9
+ key: z.ZodString;
10
+ /**
11
+ * An optional description of the document.
12
+ */
13
+ description: z.ZodOptional<z.ZodString>;
14
+ /**
15
+ * The raw data of the document.
16
+ */
17
+ data: z.ZodType<Uint8Array<ArrayBufferLike>, z.ZodTypeDef, Uint8Array<ArrayBufferLike>>;
18
+ /**
19
+ * The expected version number to ensure consistency.
20
+ * If provided, the operation will fail if the stored version does not match.
21
+ */
22
+ version: z.ZodOptional<z.ZodBigInt>;
23
+ }, "strict", z.ZodTypeAny, {
24
+ data: Uint8Array<ArrayBufferLike>;
25
+ key: string;
26
+ description?: string | undefined;
27
+ version?: bigint | undefined;
28
+ }, {
29
+ data: Uint8Array<ArrayBufferLike>;
30
+ key: string;
31
+ description?: string | undefined;
32
+ version?: bigint | undefined;
33
+ }>;
34
+ /**
35
+ * Represents a request to set or update a document.
36
+ *
37
+ * This is used when submitting new document data.
38
+ */
39
+ export type SetDoc = z.infer<typeof SetDocSchema>;
40
+ /**
41
+ * @see SetDocStoreParams
42
+ */
43
+ export declare const SetDocStoreParamsSchema: z.ZodObject<{
44
+ /**
45
+ * The caller who initiate the document operation.
46
+ */
47
+ caller: z.ZodType<Uint8Array<ArrayBufferLike>, z.ZodTypeDef, Uint8Array<ArrayBufferLike>>;
48
+ /**
49
+ * The name of the collection where the document is stored.
50
+ */
51
+ collection: z.ZodString;
52
+ /**
53
+ * The data, key and other information required to create or update a document.
54
+ */
55
+ doc: z.ZodObject<{
56
+ /**
57
+ * The unique key identifying the document within the collection.
58
+ */
59
+ key: z.ZodString;
60
+ /**
61
+ * An optional description of the document.
62
+ */
63
+ description: z.ZodOptional<z.ZodString>;
64
+ /**
65
+ * The raw data of the document.
66
+ */
67
+ data: z.ZodType<Uint8Array<ArrayBufferLike>, z.ZodTypeDef, Uint8Array<ArrayBufferLike>>;
68
+ /**
69
+ * The expected version number to ensure consistency.
70
+ * If provided, the operation will fail if the stored version does not match.
71
+ */
72
+ version: z.ZodOptional<z.ZodBigInt>;
73
+ }, "strict", z.ZodTypeAny, {
74
+ data: Uint8Array<ArrayBufferLike>;
75
+ key: string;
76
+ description?: string | undefined;
77
+ version?: bigint | undefined;
78
+ }, {
79
+ data: Uint8Array<ArrayBufferLike>;
80
+ key: string;
81
+ description?: string | undefined;
82
+ version?: bigint | undefined;
83
+ }>;
84
+ }, "strict", z.ZodTypeAny, {
85
+ caller: Uint8Array<ArrayBufferLike>;
86
+ collection: string;
87
+ doc: {
88
+ data: Uint8Array<ArrayBufferLike>;
89
+ key: string;
90
+ description?: string | undefined;
91
+ version?: bigint | undefined;
92
+ };
93
+ }, {
94
+ caller: Uint8Array<ArrayBufferLike>;
95
+ collection: string;
96
+ doc: {
97
+ data: Uint8Array<ArrayBufferLike>;
98
+ key: string;
99
+ description?: string | undefined;
100
+ version?: bigint | undefined;
101
+ };
102
+ }>;
103
+ /**
104
+ * Represents the parameters required to store or update a document.
105
+ *
106
+ * This includes the document data along with metadata such as the caller,
107
+ * collection, and key.
108
+ */
109
+ export type SetDocStoreParams = z.infer<typeof SetDocStoreParamsSchema>;
@@ -0,0 +1,17 @@
1
+ import type { RawData } from '../schemas/core';
2
+ /**
3
+ * Decodes the raw data of a document into a JavaScript object.
4
+ *
5
+ * @template T The expected type of the decoded object.
6
+ * @param {RawData} data - The raw data to be decoded.
7
+ * @returns {T} The parsed JavaScript object.
8
+ */
9
+ export declare const decodeDocData: <T>(data: RawData) => T;
10
+ /**
11
+ * Encodes a JavaScript object into a raw data format to be applied to a document.
12
+ *
13
+ * @template T The type of the object to be encoded.
14
+ * @param {T} data - The data to be encoded.
15
+ * @returns {RawData} The serialized raw data.
16
+ */
17
+ export declare const encodeDocData: <T>(data: T) => RawData;
package/sdk.d.ts ADDED
@@ -0,0 +1,3 @@
1
+ export * from './sdk/db.sdk';
2
+ export * from './sdk/schemas/db';
3
+ export * from './sdk/serializer.sdk';
package/sdk.js ADDED
@@ -0,0 +1,2 @@
1
+ import{c as e,d as a,e as r,f as c,g as s,h as m}from"./chunk-OVO3T2DM.js";import*as t from"zod";var l=t.object({key:s,description:m.optional(),data:a,version:e.optional()}).strict(),S=t.object({caller:r,collection:c,doc:l}).strict();var R=o=>{S.parse(o);let{caller:i,collection:p,doc:n}=o,{key:_,...D}=n;__juno_satellite_datastore_set_doc_store(i,p,_,D)};import{jsonReplacer as f,jsonReviver as d}from"@dfinity/utils";var T=o=>JSON.parse(__juno_satellite_datastore_raw_data_to_text(o),d),u=o=>__juno_satellite_datastore_raw_data_from_text(JSON.stringify(o,f));export{l as SetDocSchema,S as SetDocStoreParamsSchema,T as decodeDocData,u as encodeDocData,R as setDocStore};
2
+ //# sourceMappingURL=sdk.js.map
package/sdk.js.map ADDED
@@ -0,0 +1,7 @@
1
+ {
2
+ "version": 3,
3
+ "sources": ["src/sdk/schemas/db.ts", "src/sdk/db.sdk.ts", "src/sdk/serializer.sdk.ts"],
4
+ "sourcesContent": ["import * as z from 'zod';\nimport {\n CollectionSchema,\n KeySchema,\n RawDataSchema,\n RawUserIdSchema,\n VersionSchema\n} from '../../schemas/core';\nimport {DocDescriptionSchema} from '../../schemas/db';\n\n/**\n * @see SetDoc\n */\nexport const SetDocSchema = z\n .object({\n /**\n * The unique key identifying the document within the collection.\n */\n key: KeySchema,\n\n /**\n * An optional description of the document.\n */\n description: DocDescriptionSchema.optional(),\n\n /**\n * The raw data of the document.\n */\n data: RawDataSchema,\n\n /**\n * The expected version number to ensure consistency.\n * If provided, the operation will fail if the stored version does not match.\n */\n version: VersionSchema.optional()\n })\n .strict();\n\n/**\n * Represents a request to set or update a document.\n *\n * This is used when submitting new document data.\n */\nexport type SetDoc = z.infer<typeof SetDocSchema>;\n\n/**\n * @see SetDocStoreParams\n */\nexport const SetDocStoreParamsSchema = z\n .object({\n /**\n * The caller who initiate the document operation.\n */\n caller: RawUserIdSchema,\n\n /**\n * The name of the collection where the document is stored.\n */\n collection: CollectionSchema,\n\n /**\n * The data, key and other information required to create or update a document.\n */\n doc: SetDocSchema\n })\n .strict();\n\n/**\n * Represents the parameters required to store or update a document.\n *\n * This includes the document data along with metadata such as the caller,\n * collection, and key.\n */\nexport type SetDocStoreParams = z.infer<typeof SetDocStoreParamsSchema>;\n", "import {SetDocStoreParams, SetDocStoreParamsSchema} from './schemas/db';\n\n/**\n * Stores or updates a document in the datastore.\n *\n * The data must have been encoded - using encodeDocData - before calling this function.\n *\n * @param {SetDocStoreParams} params - The parameters required to store the document,\n * including the caller, collection, key, and document data.\n *\n * @throws {z.ZodError} If the provided parameters do not match the expected schema.\n * @throws {Error} If the Satellite fails at validating the submitted document before storing it.\n */\nexport const setDocStore = (params: SetDocStoreParams) => {\n SetDocStoreParamsSchema.parse(params);\n\n const {caller, collection, doc} = params;\n\n const {key, ...setDoc} = doc;\n\n __juno_satellite_datastore_set_doc_store(caller, collection, key, setDoc);\n};\n", "import {jsonReplacer, jsonReviver} from '@dfinity/utils';\nimport type {RawData} from '../schemas/core';\n\n/**\n * Decodes the raw data of a document into a JavaScript object.\n *\n * @template T The expected type of the decoded object.\n * @param {RawData} data - The raw data to be decoded.\n * @returns {T} The parsed JavaScript object.\n */\nexport const decodeDocData = <T>(data: RawData): T =>\n JSON.parse(__juno_satellite_datastore_raw_data_to_text(data), jsonReviver);\n\n/**\n * Encodes a JavaScript object into a raw data format to be applied to a document.\n *\n * @template T The type of the object to be encoded.\n * @param {T} data - The data to be encoded.\n * @returns {RawData} The serialized raw data.\n */\nexport const encodeDocData = <T>(data: T): RawData =>\n __juno_satellite_datastore_raw_data_from_text(JSON.stringify(data, jsonReplacer));\n"],
5
+ "mappings": "2EAAA,UAAYA,MAAO,MAaZ,IAAMC,EACV,SAAO,CAIN,IAAKC,EAKL,YAAaC,EAAqB,SAAS,EAK3C,KAAMC,EAMN,QAASC,EAAc,SAAS,CAClC,CAAC,EACA,OAAO,EAYGC,EACV,SAAO,CAIN,OAAQC,EAKR,WAAYC,EAKZ,IAAKP,CACP,CAAC,EACA,OAAO,ECpDH,IAAMQ,EAAeC,GAA8B,CACxDC,EAAwB,MAAMD,CAAM,EAEpC,GAAM,CAAC,OAAAE,EAAQ,WAAAC,EAAY,IAAAC,CAAG,EAAIJ,EAE5B,CAAC,IAAAK,EAAK,GAAGC,CAAM,EAAIF,EAEzB,yCAAyCF,EAAQC,EAAYE,EAAKC,CAAM,CAC1E,ECrBA,OAAQ,gBAAAC,EAAc,eAAAC,MAAkB,iBAUjC,IAAMC,EAAoBC,GAC/B,KAAK,MAAM,4CAA4CA,CAAI,EAAGF,CAAW,EAS9DG,EAAoBD,GAC/B,8CAA8C,KAAK,UAAUA,EAAMH,CAAY,CAAC",
6
+ "names": ["z", "SetDocSchema", "KeySchema", "DocDescriptionSchema", "RawDataSchema", "VersionSchema", "SetDocStoreParamsSchema", "RawUserIdSchema", "CollectionSchema", "setDocStore", "params", "SetDocStoreParamsSchema", "caller", "collection", "doc", "key", "setDoc", "jsonReplacer", "jsonReviver", "decodeDocData", "data", "encodeDocData"]
7
+ }
@@ -0,0 +1,17 @@
1
+ import type {RawData, RawPrincipal, RawUserId} from './schemas/core';
2
+ import type {SetDoc} from './sdk/schemas/db';
3
+
4
+ declare global {
5
+ function __juno_satellite_datastore_raw_data_to_text(data: RawData): string;
6
+ function __juno_satellite_datastore_raw_data_from_text(data: string): RawData;
7
+
8
+ function __juno_satellite_datastore_set_doc_store(
9
+ caller: RawUserId,
10
+ collection: string,
11
+ key: string,
12
+ value: Omit<SetDoc, 'key'>
13
+ ): void;
14
+
15
+ function __ic_cdk_id(): RawPrincipal;
16
+ function __ic_cdk_print(msg: string): void;
17
+ }
@@ -1,2 +0,0 @@
1
- import*as r from"zod";import*as s from"zod";import*as n from"zod";var T=n.bigint(),p=n.bigint(),a=n.custom(e=>e instanceof Uint8Array,{message:"Expected Uint8Array"}),j=n.custom(e=>e instanceof Uint8Array,{message:"Expected Uint8Array"}),i=j;import*as o from"zod";var z=o.string().max(1024),d=o.object({owner:i,data:a,description:z.optional(),created_at:T,updated_at:T,version:p.optional()}).strict(),h=o.object({before:d.optional(),after:d}).strict(),H=o.object({data:a,description:z.optional(),version:p.optional()}).strict(),l=o.object({current:d.optional(),proposed:H}).strict(),P=o.object({data:a,description:z.optional(),version:p.optional()}).strict();var A=e=>s.object({caller:i,data:e}).strict(),D=e=>s.object({collection:s.string(),key:s.string(),data:e}).strict(),O=A(D(h)),k=A(D(l));import*as c from"zod";var m=c.object({collections:c.array(c.string()).min(1)}).strict();import*as x from"zod";var f=x.record(x.unknown());var _=e=>m.extend({assert:r.function().args(e).returns(r.void())}).strict(),b=_(k),M=b,C=e=>r.function().args(f).returns(e),Q=e=>r.union([e,C(e)]);function W(e){return e}import*as t from"zod";var g=e=>m.extend({run:t.function().args(e).returns(t.promise(t.void()))}).strict(),F=g(O),te=F,w=e=>t.function().args(f).returns(e),oe=e=>t.union([e,w(e)]);function re(e){return e}import{jsonReplacer as R,jsonReviver as U}from"@dfinity/utils";var ce=e=>JSON.parse(__juno_satellite_datastore_raw_data_to_text(e),U),pe=e=>__juno_satellite_datastore_raw_data_from_text(JSON.stringify(e,R));import{jsonReplacer as v}from"@dfinity/utils";var S=e=>{let u=e.map(y=>typeof y=="object"?JSON.stringify(y,v):y).join(" ");globalThis.__ic_cdk_print(u)};globalThis.console={info(...e){S(e)},log(...e){S(e)},warn(...e){S(e)},error(...e){S(e)}};export{Q as AssertFnOrObjectSchema,C as AssertFnSchema,M as AssertSchema,k as AssertSetDocContextSchema,b as AssertSetDocSchema,m as CollectionsConfigSchema,l as DocAssertSetSchema,D as DocContextSchema,z as DocDescriptionSchema,d as DocSchema,h as DocUpsertSchema,oe as HookFnOrObjectSchema,w as HookFnSchema,te as HookSchema,O as OnSetDocContextSchema,F as OnSetDocSchema,H as ProposedDocSchema,a as RawDataSchema,j as RawPrincipalSchema,i as RawUserIdSchema,f as SatelliteEnvSchema,P as SetDocSchema,T as TimestampSchema,p as VersionSchema,ce as decodeDocData,W as defineAssert,re as defineHook,pe as encodeDocData};
2
- //# sourceMappingURL=index.js.map
@@ -1,7 +0,0 @@
1
- {
2
- "version": 3,
3
- "sources": ["../../src/configs/assertions.ts", "../../src/hooks/context.ts", "../../src/hooks/core.ts", "../../src/hooks/datastore.ts", "../../src/configs/collections.config.ts", "../../src/configs/satellite.env.ts", "../../src/configs/hooks.ts", "../../src/sdk/datastore.sdk.ts", "../../src/polyfills/console.polyfill.ts"],
4
- "sourcesContent": ["import * as z from 'zod';\nimport {AssertSetDocContextSchema} from '../hooks/context';\nimport {CollectionsConfigSchema} from './collections.config';\nimport {SatelliteEnvSchema} from './satellite.env';\n\n/**\n * A generic schema for defining assertions related to collections.\n *\n * @template T - The type of context passed to the assertions when triggered.\n */\nconst OnAssertSchema = <T extends z.ZodTypeAny>(contextSchema: T) =>\n CollectionsConfigSchema.extend({\n /**\n * A function that runs when the assertion is triggered for the specified collections.\n *\n * @param {T} context - Contains information about the affected document(s).\n * @returns {void} Resolves when the assertion completes.\n */\n assert: z.function().args(contextSchema).returns(z.void())\n }).strict();\n\n/**\n * @see AssertSetDoc\n */\nexport const AssertSetDocSchema = OnAssertSchema(AssertSetDocContextSchema);\n\n/**\n * An assertion that runs when a document is created or updated.\n */\nexport type AssertSetDoc = z.infer<typeof AssertSetDocSchema>;\n\n// TODO: to be extended\n/**\n * @see Assert\n */\nexport const AssertSchema = AssertSetDocSchema;\n\n/**\n * All assertions definitions.\n */\nexport type Assert = z.infer<typeof AssertSchema>;\n\nexport const AssertFnSchema = <T extends z.ZodTypeAny>(assertSchema: T) =>\n z.function().args(SatelliteEnvSchema).returns(assertSchema);\nexport type AssertFn<T extends Assert> = (assert: z.infer<typeof SatelliteEnvSchema>) => T;\n\nexport const AssertFnOrObjectSchema = <T extends z.ZodTypeAny>(assertSchema: T) =>\n z.union([assertSchema, AssertFnSchema(assertSchema)]);\nexport type AssertFnOrObject<T extends Assert> = T | AssertFn<T>;\n\nexport function defineAssert<T extends Assert>(assert: T): T;\nexport function defineAssert<T extends Assert>(assert: AssertFn<T>): AssertFn<T>;\nexport function defineAssert<T extends Assert>(assert: AssertFnOrObject<T>): AssertFnOrObject<T>;\nexport function defineAssert<T extends Assert>(assert: AssertFnOrObject<T>): AssertFnOrObject<T> {\n return assert;\n}\n", "import * as z from 'zod';\nimport {RawUserIdSchema} from './core';\nimport {DocAssertSetSchema, DocUpsertSchema} from './datastore';\n\n/**\n * @see HookContext\n */\nconst HookContextSchema = <T extends z.ZodTypeAny>(dataSchema: T) =>\n z\n .object({\n /**\n * The user who originally triggered the function that in turn triggered the hook.\n */\n caller: RawUserIdSchema,\n\n /**\n * The data associated with the hook execution.\n */\n data: dataSchema\n })\n .strict();\n\n/**\n * Represents the context provided to hooks, containing information about the caller and related data.\n *\n * @template T - The type of data associated with the hook.\n */\nexport type HookContext<T extends z.ZodTypeAny> = z.infer<ReturnType<typeof HookContextSchema<T>>>;\n\n/**\n * @see DocContext\n */\nexport const DocContextSchema = <T extends z.ZodTypeAny>(dataSchema: T) =>\n z\n .object({\n /**\n * The name of the collection where the document is stored.\n */\n collection: z.string(),\n\n /**\n * The unique key identifying the document within the collection.\n */\n key: z.string(),\n\n /**\n * The data associated with the document operation.\n */\n data: dataSchema\n })\n .strict();\n\n/**\n * Represents the context of a document operation within a collection.\n *\n * @template T - The type of data associated with the document.\n */\nexport type DocContext<T extends z.ZodTypeAny> = z.infer<ReturnType<typeof DocContextSchema<T>>>;\n\n/**\n * @see OnSetDocContext\n */\nexport const OnSetDocContextSchema = HookContextSchema(DocContextSchema(DocUpsertSchema));\n\n/**\n * The context provided to the `onSetDoc` hook.\n *\n * This context contains information about the document being created or updated,\n * along with details about the user who triggered the operation.\n */\nexport type OnSetDocContext = z.infer<typeof OnSetDocContextSchema>;\n\n/**\n * @see AssertSetDocContext\n */\nexport const AssertSetDocContextSchema = HookContextSchema(DocContextSchema(DocAssertSetSchema));\n\n/**\n * The context provided to the `assertSetDoc` hook.\n *\n * This context contains information about the document being validated before\n * it is created or updated. If validation fails, the developer should throw an error.\n */\nexport type AssertSetDocContext = z.infer<typeof AssertSetDocContextSchema>;\n", "import * as z from 'zod';\n\n/**\n * @see Timestamp\n */\nexport const TimestampSchema = z.bigint();\n\n/**\n * Represents a timestamp in nanoseconds since the Unix epoch.\n *\n * Used for tracking when events occur, such as document creation and updates.\n */\nexport type Timestamp = z.infer<typeof TimestampSchema>;\n\n/**\n * @see Version\n */\nexport const VersionSchema = z.bigint();\n\n/**\n * Represents a version number for tracking changes.\n *\n * This is typically incremented with each update to ensure consistency.\n */\nexport type Version = z.infer<typeof VersionSchema>;\n\n/**\n * @see RawData\n */\nexport const RawDataSchema = z.custom<Uint8Array>((val) => val instanceof Uint8Array, {\n message: 'Expected Uint8Array'\n});\n\n/**\n * Represents raw binary data.\n *\n * This is used to store unstructured data in a document.\n */\nexport type RawData = z.infer<typeof RawDataSchema>;\n\n/**\n * @see RawPrincipal\n */\nexport const RawPrincipalSchema = z.custom<Uint8Array>((val) => val instanceof Uint8Array, {\n message: 'Expected Uint8Array'\n});\n\n/**\n * Represents a raw principal identifier.\n *\n * Principals are unique identities used in authentication and authorization.\n */\nexport type RawPrincipal = z.infer<typeof RawPrincipalSchema>;\n\n/**\n * @see RawUserId\n */\nexport const RawUserIdSchema = RawPrincipalSchema;\n\n/**\n * Represents a raw user identifier.\n *\n * This is a principal associated with a user.\n */\nexport type RawUserId = z.infer<typeof RawUserIdSchema>;\n", "import * as z from 'zod';\nimport {RawDataSchema, RawUserIdSchema, TimestampSchema, VersionSchema} from './core';\n\n/**\n * @see DocDescription\n */\nexport const DocDescriptionSchema = z.string().max(1024);\n\n/**\n * Represents a document description with a maximum length of 1024 characters.\n */\nexport type DocDescription = z.infer<typeof DocDescriptionSchema>;\n\n/**\n * @see Doc\n */\nexport const DocSchema = z\n .object({\n /**\n * The user who owns this document.\n */\n owner: RawUserIdSchema,\n\n /**\n * The raw data of the document.\n */\n data: RawDataSchema,\n\n /**\n * An optional description of the document.\n */\n description: DocDescriptionSchema.optional(),\n\n /**\n * The timestamp when the document was first created.\n */\n created_at: TimestampSchema,\n\n /**\n * The timestamp when the document was last updated.\n */\n updated_at: TimestampSchema,\n\n /**\n * The version number of the document, used for consistency checks.\n * If not provided, it's assumed to be the first version.\n */\n version: VersionSchema.optional()\n })\n .strict();\n\n/**\n * Represents a document stored in a collection.\n */\nexport type Doc = z.infer<typeof DocSchema>;\n\n/**\n * @see DocUpsert\n */\nexport const DocUpsertSchema = z\n .object({\n /**\n * The previous version of the document before the update.\n * Undefined if this is a new document.\n */\n before: DocSchema.optional(),\n\n /**\n * The new version of the document after the update.\n */\n after: DocSchema\n })\n .strict();\n\n/**\n * Represents a document update operation.\n *\n * This is used in hooks where a document is either being created or updated.\n */\nexport type DocUpsert = z.infer<typeof DocUpsertSchema>;\n\n/**\n * @see ProposedDoc\n */\nexport const ProposedDocSchema = z\n .object({\n /**\n * The raw data of the document.\n */\n data: RawDataSchema,\n\n /**\n * An optional description of the document.\n */\n description: DocDescriptionSchema.optional(),\n\n /**\n * The expected version number to ensure consistency.\n */\n version: VersionSchema.optional()\n })\n .strict();\n\n/**\n * Represents the proposed version of a document.\n * This can be validated before allowing the operation.\n */\nexport type ProposedDoc = z.infer<typeof ProposedDocSchema>;\n\n/**\n * @see DocAssertSet\n */\nexport const DocAssertSetSchema = z\n .object({\n /**\n * The current version of the document before the operation.\n * Undefined if this is a new document.\n */\n current: DocSchema.optional(),\n\n /**\n * The proposed version of the document.\n * This can be validated before allowing the operation.\n */\n proposed: ProposedDocSchema\n })\n .strict();\n\n/**\n * Represents a validation check before setting a document.\n *\n * The developer can compare the `current` and `proposed` versions and\n * throw an error if their validation fails.\n */\nexport type DocAssertSet = z.infer<typeof DocAssertSetSchema>;\n\n/**\n * @see SetDoc\n */\nexport const SetDocSchema = z\n .object({\n /**\n * The raw data of the document.\n */\n data: RawDataSchema,\n\n /**\n * An optional description of the document.\n */\n description: DocDescriptionSchema.optional(),\n\n /**\n * The expected version number to ensure consistency.\n * If provided, the operation will fail if the stored version does not match.\n */\n version: VersionSchema.optional()\n })\n .strict();\n\n/**\n * Represents a request to set or update a document.\n *\n * This is used when submitting new document data.\n */\nexport type SetDoc = z.infer<typeof SetDocSchema>;\n", "import * as z from 'zod';\n\n/**\n * @see CollectionsConfig\n */\nexport const CollectionsConfigSchema = z\n .object({\n /**\n * An array containing at least one collection name where the hook or assertion will be executed.\n */\n collections: z.array(z.string()).min(1)\n })\n .strict();\n\n/**\n * Defines the collections where a hook or assertion should run.\n */\nexport type CollectionsConfig = z.infer<typeof CollectionsConfigSchema>;\n", "import * as z from 'zod';\n\n/**\n * @see SatelliteEnv\n */\nexport const SatelliteEnvSchema = z.record(z.unknown());\n\n/**\n * Placeholder for future environment-specific configurations.\n *\n * Currently unused, but it may support features such as:\n * - Defining the execution mode (e.g., staging or production).\n * - Providing environment-specific values like `ckBtcLedgerId` for test or production.\n */\nexport type SatelliteEnv = z.infer<typeof SatelliteEnvSchema>;\n", "import * as z from 'zod';\nimport {OnSetDocContextSchema} from '../hooks/context';\nimport {CollectionsConfigSchema} from './collections.config';\nimport {SatelliteEnvSchema} from './satellite.env';\n\n/**\n * A generic schema for defining hooks related to collections.\n *\n * @template T - The type of context passed to the hook when triggered.\n */\nconst OnHookSchema = <T extends z.ZodTypeAny>(contextSchema: T) =>\n CollectionsConfigSchema.extend({\n /**\n * A function that runs when the hook is triggered for the specified collections.\n *\n * @param {T} context - Contains information about the affected document(s).\n * @returns {Promise<void>} Resolves when the operation completes.\n */\n run: z.function().args(contextSchema).returns(z.promise(z.void()))\n }).strict();\n\n/**\n * @see OnSetDoc\n */\nexport const OnSetDocSchema = OnHookSchema(OnSetDocContextSchema);\n\n/**\n * A hook that runs when a document is created or updated.\n */\nexport type OnSetDoc = z.infer<typeof OnSetDocSchema>;\n\n// TODO: to be extended\n/**\n * @see Hook\n */\nexport const HookSchema = OnSetDocSchema;\n\n/**\n * All hooks definitions.\n */\nexport type Hook = z.infer<typeof HookSchema>;\n\nexport const HookFnSchema = <T extends z.ZodTypeAny>(hookSchema: T) =>\n z.function().args(SatelliteEnvSchema).returns(hookSchema);\nexport type HookFn<T extends Hook> = (hook: z.infer<typeof SatelliteEnvSchema>) => T;\n\nexport const HookFnOrObjectSchema = <T extends z.ZodTypeAny>(hookSchema: T) =>\n z.union([hookSchema, HookFnSchema(hookSchema)]);\nexport type HookFnOrObject<T extends Hook> = T | HookFn<T>;\n\nexport function defineHook<T extends Hook>(hook: T): T;\nexport function defineHook<T extends Hook>(hook: HookFn<T>): HookFn<T>;\nexport function defineHook<T extends Hook>(hook: HookFnOrObject<T>): HookFnOrObject<T>;\nexport function defineHook<T extends Hook>(hook: HookFnOrObject<T>): HookFnOrObject<T> {\n return hook;\n}\n", "import {jsonReplacer, jsonReviver} from '@dfinity/utils';\nimport type {RawData} from '../hooks/core';\n\nexport const decodeDocData = <T>(data: RawData): T =>\n JSON.parse(__juno_satellite_datastore_raw_data_to_text(data), jsonReviver);\n\nexport const encodeDocData = <T>(data: T): RawData =>\n __juno_satellite_datastore_raw_data_from_text(JSON.stringify(data, jsonReplacer));\n", "import {jsonReplacer} from '@dfinity/utils';\n\n// eslint-disable-next-line @typescript-eslint/no-explicit-any\nconst __juno_satellite_console_log = (v: any[]) => {\n const msg = v\n .map((arg) => (typeof arg === 'object' ? JSON.stringify(arg, jsonReplacer) : arg))\n .join(' ');\n\n globalThis.__ic_cdk_print(msg);\n};\n\n// @ts-expect-error We want to override the console\nglobalThis.console = {\n // eslint-disable-next-line @typescript-eslint/no-explicit-any\n info(...v: any[]) {\n __juno_satellite_console_log(v);\n },\n // eslint-disable-next-line @typescript-eslint/no-explicit-any\n log(...v: any[]) {\n __juno_satellite_console_log(v);\n },\n // eslint-disable-next-line @typescript-eslint/no-explicit-any\n warn(...v: any[]) {\n __juno_satellite_console_log(v);\n },\n // eslint-disable-next-line @typescript-eslint/no-explicit-any\n error(...v: any[]) {\n __juno_satellite_console_log(v);\n }\n};\n"],
5
- "mappings": "AAAA,UAAYA,MAAO,MCAnB,UAAYC,MAAO,MCAnB,UAAYC,MAAO,MAKZ,IAAMC,EAAoB,SAAO,EAY3BC,EAAkB,SAAO,EAYzBC,EAAkB,SAAoBC,GAAQA,aAAe,WAAY,CACpF,QAAS,qBACX,CAAC,EAYYC,EAAuB,SAAoBD,GAAQA,aAAe,WAAY,CACzF,QAAS,qBACX,CAAC,EAYYE,EAAkBD,ECzD/B,UAAYE,MAAO,MAMZ,IAAMC,EAAyB,SAAO,EAAE,IAAI,IAAI,EAU1CC,EACV,SAAO,CAIN,MAAOC,EAKP,KAAMC,EAKN,YAAaH,EAAqB,SAAS,EAK3C,WAAYI,EAKZ,WAAYA,EAMZ,QAASC,EAAc,SAAS,CAClC,CAAC,EACA,OAAO,EAUGC,EACV,SAAO,CAKN,OAAQL,EAAU,SAAS,EAK3B,MAAOA,CACT,CAAC,EACA,OAAO,EAYGM,EACV,SAAO,CAIN,KAAMJ,EAKN,YAAaH,EAAqB,SAAS,EAK3C,QAASK,EAAc,SAAS,CAClC,CAAC,EACA,OAAO,EAWGG,EACV,SAAO,CAKN,QAASP,EAAU,SAAS,EAM5B,SAAUM,CACZ,CAAC,EACA,OAAO,EAaGE,EACV,SAAO,CAIN,KAAMN,EAKN,YAAaH,EAAqB,SAAS,EAM3C,QAASK,EAAc,SAAS,CAClC,CAAC,EACA,OAAO,EFtJV,IAAMK,EAA6CC,GAE9C,SAAO,CAIN,OAAQC,EAKR,KAAMD,CACR,CAAC,EACA,OAAO,EAYCE,EAA4CF,GAEpD,SAAO,CAIN,WAAc,SAAO,EAKrB,IAAO,SAAO,EAKd,KAAMA,CACR,CAAC,EACA,OAAO,EAYCG,EAAwBJ,EAAkBG,EAAiBE,CAAe,CAAC,EAa3EC,EAA4BN,EAAkBG,EAAiBI,CAAkB,CAAC,EG3E/F,UAAYC,MAAO,MAKZ,IAAMC,EACV,SAAO,CAIN,YAAe,QAAQ,SAAO,CAAC,EAAE,IAAI,CAAC,CACxC,CAAC,EACA,OAAO,ECZV,UAAYC,MAAO,MAKZ,IAAMC,EAAuB,SAAS,UAAQ,CAAC,ELKtD,IAAMC,EAA0CC,GAC9CC,EAAwB,OAAO,CAO7B,OAAU,WAAS,EAAE,KAAKD,CAAa,EAAE,QAAU,OAAK,CAAC,CAC3D,CAAC,EAAE,OAAO,EAKCE,EAAqBH,EAAeI,CAAyB,EAW7DC,EAAeF,EAOfG,EAA0CC,GACnD,WAAS,EAAE,KAAKC,CAAkB,EAAE,QAAQD,CAAY,EAG/CE,EAAkDF,GAC3D,QAAM,CAACA,EAAcD,EAAeC,CAAY,CAAC,CAAC,EAM/C,SAASG,EAA+BC,EAAkD,CAC/F,OAAOA,CACT,CMvDA,UAAYC,MAAO,MAUnB,IAAMC,EAAwCC,GAC5CC,EAAwB,OAAO,CAO7B,IAAO,WAAS,EAAE,KAAKD,CAAa,EAAE,QAAU,UAAU,OAAK,CAAC,CAAC,CACnE,CAAC,EAAE,OAAO,EAKCE,EAAiBH,EAAaI,CAAqB,EAWnDC,GAAaF,EAObG,EAAwCC,GACjD,WAAS,EAAE,KAAKC,CAAkB,EAAE,QAAQD,CAAU,EAG7CE,GAAgDF,GACzD,QAAM,CAACA,EAAYD,EAAaC,CAAU,CAAC,CAAC,EAMzC,SAASG,GAA2BC,EAA4C,CACrF,OAAOA,CACT,CCvDA,OAAQ,gBAAAC,EAAc,eAAAC,MAAkB,iBAGjC,IAAMC,GAAoBC,GAC/B,KAAK,MAAM,4CAA4CA,CAAI,EAAGF,CAAW,EAE9DG,GAAoBD,GAC/B,8CAA8C,KAAK,UAAUA,EAAMH,CAAY,CAAC,ECPlF,OAAQ,gBAAAK,MAAmB,iBAG3B,IAAMC,EAAgCC,GAAa,CACjD,IAAMC,EAAMD,EACT,IAAKE,GAAS,OAAOA,GAAQ,SAAW,KAAK,UAAUA,EAAKJ,CAAY,EAAII,CAAI,EAChF,KAAK,GAAG,EAEX,WAAW,eAAeD,CAAG,CAC/B,EAGA,WAAW,QAAU,CAEnB,QAAQD,EAAU,CAChBD,EAA6BC,CAAC,CAChC,EAEA,OAAOA,EAAU,CACfD,EAA6BC,CAAC,CAChC,EAEA,QAAQA,EAAU,CAChBD,EAA6BC,CAAC,CAChC,EAEA,SAASA,EAAU,CACjBD,EAA6BC,CAAC,CAChC,CACF",
6
- "names": ["z", "z", "z", "TimestampSchema", "VersionSchema", "RawDataSchema", "val", "RawPrincipalSchema", "RawUserIdSchema", "z", "DocDescriptionSchema", "DocSchema", "RawUserIdSchema", "RawDataSchema", "TimestampSchema", "VersionSchema", "DocUpsertSchema", "ProposedDocSchema", "DocAssertSetSchema", "SetDocSchema", "HookContextSchema", "dataSchema", "RawUserIdSchema", "DocContextSchema", "OnSetDocContextSchema", "DocUpsertSchema", "AssertSetDocContextSchema", "DocAssertSetSchema", "z", "CollectionsConfigSchema", "z", "SatelliteEnvSchema", "OnAssertSchema", "contextSchema", "CollectionsConfigSchema", "AssertSetDocSchema", "AssertSetDocContextSchema", "AssertSchema", "AssertFnSchema", "assertSchema", "SatelliteEnvSchema", "AssertFnOrObjectSchema", "defineAssert", "assert", "z", "OnHookSchema", "contextSchema", "CollectionsConfigSchema", "OnSetDocSchema", "OnSetDocContextSchema", "HookSchema", "HookFnSchema", "hookSchema", "SatelliteEnvSchema", "HookFnOrObjectSchema", "defineHook", "hook", "jsonReplacer", "jsonReviver", "decodeDocData", "data", "encodeDocData", "jsonReplacer", "__juno_satellite_console_log", "v", "msg", "arg"]
7
- }
package/dist/index.js DELETED
@@ -1 +0,0 @@
1
- export * from './browser/index.js';
@@ -1,8 +0,0 @@
1
- import type {RawData} from './hooks/core';
2
-
3
- declare global {
4
- function __juno_satellite_datastore_raw_data_to_text(data: RawData): string;
5
- function __juno_satellite_datastore_raw_data_from_text(data: string): RawData;
6
-
7
- function __ic_cdk_print(msg: string): void;
8
- }
@@ -1,9 +0,0 @@
1
- export * from './configs/assertions';
2
- export * from './configs/collections.config';
3
- export * from './configs/hooks';
4
- export * from './configs/satellite.env';
5
- export * from './hooks/context';
6
- export * from './hooks/core';
7
- export * from './hooks/datastore';
8
- export * from './sdk/datastore.sdk';
9
- import './polyfills/console.polyfill';
@@ -1,3 +0,0 @@
1
- import type { RawData } from '../hooks/core';
2
- export declare const decodeDocData: <T>(data: RawData) => T;
3
- export declare const encodeDocData: <T>(data: T) => RawData;