@yolk-sdk/emulators 0.1.0-canary.96

package/dist/notion/state.d.mts

@@ -0,0 +1,329 @@
+import * as Schema from "effect/Schema";
+
+//#region src/notion/state.d.ts
+/** A Notion id as stored and answered: a lower-case dashed UUID. */
+declare const notionIdPattern: RegExp;
+/** The integration's bot user (`GET /v1/users/me`). */
+declare const NotionEmulatorBotUser: Schema.Struct<{
+  readonly id: Schema.String;
+  readonly name: Schema.String;
+  readonly avatarUrl: Schema.NullOr<Schema.String>;
+  readonly workspaceName: Schema.String;
+}>;
+type NotionEmulatorBotUser = typeof NotionEmulatorBotUser.Type;
+/** A page parent as Notion answers it. */
+declare const NotionEmulatorParent: Schema.Union<readonly [Schema.Struct<{
+  readonly type: Schema.Literal<"workspace">;
+  readonly workspace: Schema.Literal<true>;
+}>, Schema.Struct<{
+  readonly type: Schema.Literal<"page_id">;
+  readonly page_id: Schema.String;
+}>, Schema.Struct<{
+  readonly type: Schema.Literal<"data_source_id">;
+  readonly data_source_id: Schema.String;
+  readonly database_id: Schema.String;
+}>]>;
+type NotionEmulatorParent = typeof NotionEmulatorParent.Type;
+/** A stored page. `times` is `null` where the fixture omits both timestamps (data source rows). */
+declare const NotionEmulatorPage: Schema.Struct<{
+  readonly id: Schema.String;
+  readonly times: Schema.NullOr<Schema.Struct<{
+    readonly created: Schema.String;
+    readonly lastEdited: Schema.String;
+  }>>;
+  readonly parent: Schema.Union<readonly [Schema.Struct<{
+    readonly type: Schema.Literal<"workspace">;
+    readonly workspace: Schema.Literal<true>;
+  }>, Schema.Struct<{
+    readonly type: Schema.Literal<"page_id">;
+    readonly page_id: Schema.String;
+  }>, Schema.Struct<{
+    readonly type: Schema.Literal<"data_source_id">;
+    readonly data_source_id: Schema.String;
+    readonly database_id: Schema.String;
+  }>]>;
+  readonly archived: Schema.Boolean;
+  readonly inTrash: Schema.Boolean; /** The page object's `properties`, answered as stored. */
+  readonly properties: Schema.$Record<Schema.String, Schema.Codec<Schema.Json, Schema.Json, never, never>>;
+  readonly url: Schema.String;
+}>;
+type NotionEmulatorPage = typeof NotionEmulatorPage.Type;
+/** A stored block, a child of a page. */
+declare const NotionEmulatorBlock: Schema.Struct<{
+  readonly id: Schema.String;
+  readonly pageId: Schema.String;
+  readonly createdTime: Schema.String;
+  readonly lastEditedTime: Schema.String;
+  readonly hasChildren: Schema.Boolean;
+  readonly archived: Schema.Boolean;
+  readonly inTrash: Schema.Boolean; /** Block type, for example `paragraph`. */
+  readonly type: Schema.String; /** The type-specific value (`paragraph: { rich_text, color }`). */
+  readonly value: Schema.$Record<Schema.String, Schema.Codec<Schema.Json, Schema.Json, never, never>>;
+}>;
+type NotionEmulatorBlock = typeof NotionEmulatorBlock.Type;
+/**
+ * The items of one paginated page property, as the property endpoint pages through them. Each
+ * item answers `{ object: "property_item", id, type, [type]: value }`.
+ */
+declare const NotionEmulatorPropertyItems: Schema.Struct<{
+  readonly pageId: Schema.String; /** The property id exactly as the page object returns it (for example `Syn%3Ap`). */
+  readonly propertyId: Schema.String;
+  readonly type: Schema.String;
+  readonly values: Schema.$Array<Schema.Codec<Schema.Json, Schema.Json, never, never>>;
+}>;
+type NotionEmulatorPropertyItems = typeof NotionEmulatorPropertyItems.Type;
+declare const NotionEmulatorDatabase: Schema.Struct<{
+  readonly id: Schema.String;
+  readonly title: Schema.$Array<Schema.Codec<Schema.Json, Schema.Json, never, never>>;
+  readonly description: Schema.$Array<Schema.Codec<Schema.Json, Schema.Json, never, never>>;
+  readonly parent: Schema.Struct<{
+    readonly type: Schema.Literal<"page_id">;
+    readonly page_id: Schema.String;
+  }>;
+  readonly isInline: Schema.Boolean;
+  readonly inTrash: Schema.Boolean;
+  readonly archived: Schema.Boolean;
+  readonly createdTime: Schema.String;
+  readonly lastEditedTime: Schema.String;
+  readonly url: Schema.String;
+}>;
+type NotionEmulatorDatabase = typeof NotionEmulatorDatabase.Type;
+/** A data source of a database: its schema; its rows are pages with a `data_source_id` parent. */
+declare const NotionEmulatorDataSource: Schema.Struct<{
+  readonly id: Schema.String;
+  readonly databaseId: Schema.String; /** Rich text title; its plain text is the name the database lists. */
+  readonly title: Schema.$Array<Schema.Codec<Schema.Json, Schema.Json, never, never>>;
+  readonly properties: Schema.$Record<Schema.String, Schema.Codec<Schema.Json, Schema.Json, never, never>>;
+  readonly archived: Schema.Boolean;
+  readonly inTrash: Schema.Boolean;
+}>;
+type NotionEmulatorDataSource = typeof NotionEmulatorDataSource.Type;
+/**
+ * A page a fixture names by id but never shows (no title, properties, or timestamps): accepted
+ * where a fixture names it (a block parent, a create parent, a database parent, a query row), never
+ * rendered. `parent` is set only for a data source row.
+ */
+declare const NotionEmulatorImpliedPage: Schema.Struct<{
+  readonly id: Schema.String;
+  readonly parent: Schema.NullOr<Schema.Union<readonly [Schema.Struct<{
+    readonly type: Schema.Literal<"workspace">;
+    readonly workspace: Schema.Literal<true>;
+  }>, Schema.Struct<{
+    readonly type: Schema.Literal<"page_id">;
+    readonly page_id: Schema.String;
+  }>, Schema.Struct<{
+    readonly type: Schema.Literal<"data_source_id">;
+    readonly data_source_id: Schema.String;
+    readonly database_id: Schema.String;
+  }>]>>;
+}>;
+type NotionEmulatorImpliedPage = typeof NotionEmulatorImpliedPage.Type;
+declare const Counters: Schema.Struct<{
+  /** Next number in created page ids (`1f0000e0-0000-4000-8000-000000000001`). */readonly nextPageNumber: Schema.Int;
+}>;
+/** The whole emulator state (JSON-compatible; what `snapshot()` returns). */
+declare const NotionEmulatorStateSchema: Schema.Struct<{
+  readonly botUser: Schema.Struct<{
+    readonly id: Schema.String;
+    readonly name: Schema.String;
+    readonly avatarUrl: Schema.NullOr<Schema.String>;
+    readonly workspaceName: Schema.String;
+  }>;
+  readonly pages: Schema.$Array<Schema.Struct<{
+    readonly id: Schema.String;
+    readonly times: Schema.NullOr<Schema.Struct<{
+      readonly created: Schema.String;
+      readonly lastEdited: Schema.String;
+    }>>;
+    readonly parent: Schema.Union<readonly [Schema.Struct<{
+      readonly type: Schema.Literal<"workspace">;
+      readonly workspace: Schema.Literal<true>;
+    }>, Schema.Struct<{
+      readonly type: Schema.Literal<"page_id">;
+      readonly page_id: Schema.String;
+    }>, Schema.Struct<{
+      readonly type: Schema.Literal<"data_source_id">;
+      readonly data_source_id: Schema.String;
+      readonly database_id: Schema.String;
+    }>]>;
+    readonly archived: Schema.Boolean;
+    readonly inTrash: Schema.Boolean; /** The page object's `properties`, answered as stored. */
+    readonly properties: Schema.$Record<Schema.String, Schema.Codec<Schema.Json, Schema.Json, never, never>>;
+    readonly url: Schema.String;
+  }>>;
+  readonly impliedPages: Schema.$Array<Schema.Struct<{
+    readonly id: Schema.String;
+    readonly parent: Schema.NullOr<Schema.Union<readonly [Schema.Struct<{
+      readonly type: Schema.Literal<"workspace">;
+      readonly workspace: Schema.Literal<true>;
+    }>, Schema.Struct<{
+      readonly type: Schema.Literal<"page_id">;
+      readonly page_id: Schema.String;
+    }>, Schema.Struct<{
+      readonly type: Schema.Literal<"data_source_id">;
+      readonly data_source_id: Schema.String;
+      readonly database_id: Schema.String;
+    }>]>>;
+  }>>;
+  readonly blocks: Schema.$Array<Schema.Struct<{
+    readonly id: Schema.String;
+    readonly pageId: Schema.String;
+    readonly createdTime: Schema.String;
+    readonly lastEditedTime: Schema.String;
+    readonly hasChildren: Schema.Boolean;
+    readonly archived: Schema.Boolean;
+    readonly inTrash: Schema.Boolean; /** Block type, for example `paragraph`. */
+    readonly type: Schema.String; /** The type-specific value (`paragraph: { rich_text, color }`). */
+    readonly value: Schema.$Record<Schema.String, Schema.Codec<Schema.Json, Schema.Json, never, never>>;
+  }>>;
+  readonly propertyItems: Schema.$Array<Schema.Struct<{
+    readonly pageId: Schema.String; /** The property id exactly as the page object returns it (for example `Syn%3Ap`). */
+    readonly propertyId: Schema.String;
+    readonly type: Schema.String;
+    readonly values: Schema.$Array<Schema.Codec<Schema.Json, Schema.Json, never, never>>;
+  }>>;
+  readonly databases: Schema.$Array<Schema.Struct<{
+    readonly id: Schema.String;
+    readonly title: Schema.$Array<Schema.Codec<Schema.Json, Schema.Json, never, never>>;
+    readonly description: Schema.$Array<Schema.Codec<Schema.Json, Schema.Json, never, never>>;
+    readonly parent: Schema.Struct<{
+      readonly type: Schema.Literal<"page_id">;
+      readonly page_id: Schema.String;
+    }>;
+    readonly isInline: Schema.Boolean;
+    readonly inTrash: Schema.Boolean;
+    readonly archived: Schema.Boolean;
+    readonly createdTime: Schema.String;
+    readonly lastEditedTime: Schema.String;
+    readonly url: Schema.String;
+  }>>;
+  readonly dataSources: Schema.$Array<Schema.Struct<{
+    readonly id: Schema.String;
+    readonly databaseId: Schema.String; /** Rich text title; its plain text is the name the database lists. */
+    readonly title: Schema.$Array<Schema.Codec<Schema.Json, Schema.Json, never, never>>;
+    readonly properties: Schema.$Record<Schema.String, Schema.Codec<Schema.Json, Schema.Json, never, never>>;
+    readonly archived: Schema.Boolean;
+    readonly inTrash: Schema.Boolean;
+  }>>;
+  readonly counters: Schema.Struct<{
+    /** Next number in created page ids (`1f0000e0-0000-4000-8000-000000000001`). */readonly nextPageNumber: Schema.Int;
+  }>;
+}>;
+/**
+ * The emulator state. The container is mutable (routes replace whole lists); every entity is
+ * replaced, never edited in place.
+ */
+type NotionEmulatorState = {
+  botUser: NotionEmulatorBotUser;
+  pages: ReadonlyArray<NotionEmulatorPage>;
+  impliedPages: ReadonlyArray<NotionEmulatorImpliedPage>;
+  blocks: ReadonlyArray<NotionEmulatorBlock>;
+  propertyItems: ReadonlyArray<NotionEmulatorPropertyItems>;
+  databases: ReadonlyArray<NotionEmulatorDatabase>;
+  dataSources: ReadonlyArray<NotionEmulatorDataSource>;
+  counters: typeof Counters.Type;
+};
+/** Account-variance profiles for the default seed. */
+declare const NotionEmulatorProfile: Schema.Literals<readonly ["default", "empty"]>;
+type NotionEmulatorProfile = typeof NotionEmulatorProfile.Type;
+/**
+ * A typed seed. Start from `profile` (default `'default'`, the fixture entities); every other key,
+ * when given, replaces that part of the profile.
+ */
+declare const NotionEmulatorSeed: Schema.Struct<{
+  readonly profile: Schema.optionalKey<Schema.Literals<readonly ["default", "empty"]>>;
+  readonly botUser: Schema.optionalKey<Schema.Struct<{
+    readonly id: Schema.String;
+    readonly name: Schema.String;
+    readonly avatarUrl: Schema.NullOr<Schema.String>;
+    readonly workspaceName: Schema.String;
+  }>>;
+  readonly pages: Schema.optionalKey<Schema.$Array<Schema.Struct<{
+    readonly id: Schema.String;
+    readonly times: Schema.NullOr<Schema.Struct<{
+      readonly created: Schema.String;
+      readonly lastEdited: Schema.String;
+    }>>;
+    readonly parent: Schema.Union<readonly [Schema.Struct<{
+      readonly type: Schema.Literal<"workspace">;
+      readonly workspace: Schema.Literal<true>;
+    }>, Schema.Struct<{
+      readonly type: Schema.Literal<"page_id">;
+      readonly page_id: Schema.String;
+    }>, Schema.Struct<{
+      readonly type: Schema.Literal<"data_source_id">;
+      readonly data_source_id: Schema.String;
+      readonly database_id: Schema.String;
+    }>]>;
+    readonly archived: Schema.Boolean;
+    readonly inTrash: Schema.Boolean; /** The page object's `properties`, answered as stored. */
+    readonly properties: Schema.$Record<Schema.String, Schema.Codec<Schema.Json, Schema.Json, never, never>>;
+    readonly url: Schema.String;
+  }>>>;
+  readonly impliedPages: Schema.optionalKey<Schema.$Array<Schema.Struct<{
+    readonly id: Schema.String;
+    readonly parent: Schema.NullOr<Schema.Union<readonly [Schema.Struct<{
+      readonly type: Schema.Literal<"workspace">;
+      readonly workspace: Schema.Literal<true>;
+    }>, Schema.Struct<{
+      readonly type: Schema.Literal<"page_id">;
+      readonly page_id: Schema.String;
+    }>, Schema.Struct<{
+      readonly type: Schema.Literal<"data_source_id">;
+      readonly data_source_id: Schema.String;
+      readonly database_id: Schema.String;
+    }>]>>;
+  }>>>;
+  readonly blocks: Schema.optionalKey<Schema.$Array<Schema.Struct<{
+    readonly id: Schema.String;
+    readonly pageId: Schema.String;
+    readonly createdTime: Schema.String;
+    readonly lastEditedTime: Schema.String;
+    readonly hasChildren: Schema.Boolean;
+    readonly archived: Schema.Boolean;
+    readonly inTrash: Schema.Boolean; /** Block type, for example `paragraph`. */
+    readonly type: Schema.String; /** The type-specific value (`paragraph: { rich_text, color }`). */
+    readonly value: Schema.$Record<Schema.String, Schema.Codec<Schema.Json, Schema.Json, never, never>>;
+  }>>>;
+  readonly propertyItems: Schema.optionalKey<Schema.$Array<Schema.Struct<{
+    readonly pageId: Schema.String; /** The property id exactly as the page object returns it (for example `Syn%3Ap`). */
+    readonly propertyId: Schema.String;
+    readonly type: Schema.String;
+    readonly values: Schema.$Array<Schema.Codec<Schema.Json, Schema.Json, never, never>>;
+  }>>>;
+  readonly databases: Schema.optionalKey<Schema.$Array<Schema.Struct<{
+    readonly id: Schema.String;
+    readonly title: Schema.$Array<Schema.Codec<Schema.Json, Schema.Json, never, never>>;
+    readonly description: Schema.$Array<Schema.Codec<Schema.Json, Schema.Json, never, never>>;
+    readonly parent: Schema.Struct<{
+      readonly type: Schema.Literal<"page_id">;
+      readonly page_id: Schema.String;
+    }>;
+    readonly isInline: Schema.Boolean;
+    readonly inTrash: Schema.Boolean;
+    readonly archived: Schema.Boolean;
+    readonly createdTime: Schema.String;
+    readonly lastEditedTime: Schema.String;
+    readonly url: Schema.String;
+  }>>>;
+  readonly dataSources: Schema.optionalKey<Schema.$Array<Schema.Struct<{
+    readonly id: Schema.String;
+    readonly databaseId: Schema.String; /** Rich text title; its plain text is the name the database lists. */
+    readonly title: Schema.$Array<Schema.Codec<Schema.Json, Schema.Json, never, never>>;
+    readonly properties: Schema.$Record<Schema.String, Schema.Codec<Schema.Json, Schema.Json, never, never>>;
+    readonly archived: Schema.Boolean;
+    readonly inTrash: Schema.Boolean;
+  }>>>;
+}>;
+type NotionEmulatorSeed = typeof NotionEmulatorSeed.Type;
+/** A plain rich text item as the fixtures write it (no annotations). */
+declare const plainRichText: (text: string) => Schema.JsonObject;
+/** A page `title` property as the fixtures write it. */
+declare const titleProperty: (items: ReadonlyArray<Schema.Json>) => Schema.JsonObject;
+/** Decode and build a seed; a string is the reason it is invalid. */
+declare const buildSeedState: (input: unknown) => NotionEmulatorState | string;
+/** Decode a full state (a restored snapshot); a string is the reason it is invalid. */
+declare const decodeState: (input: unknown) => NotionEmulatorState | string;
+//#endregion
+export { NotionEmulatorBlock, NotionEmulatorBotUser, NotionEmulatorDataSource, NotionEmulatorDatabase, NotionEmulatorImpliedPage, NotionEmulatorPage, NotionEmulatorParent, NotionEmulatorProfile, NotionEmulatorPropertyItems, NotionEmulatorSeed, NotionEmulatorState, NotionEmulatorStateSchema, buildSeedState, decodeState, notionIdPattern, plainRichText, titleProperty };
+//# sourceMappingURL=state.d.mts.map

package/dist/notion/state.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"state.d.mts","names":[],"sources":["../../src/notion/state.ts"],"mappings":";;;;cA2Ba,eAAA,EAAe,MAAmE;AAA/F;AAAA,cASa,qBAAA,EAAqB,MAAA,CAAA,MAAA;EAAA;;;;;KAOtB,qBAAA,UAA+B,qBAAA,CAAsB,IAAI;;cAGxD,oBAAA,EAAoB,MAAA,CAAA,KAAA,WAAA,MAAA,CAAA,MAAA;EAAA;;;;;;;;;;KAUrB,oBAAA,UAA8B,oBAAA,CAAqB,IAAI;;cAGtD,kBAAA,EAAkB,MAAA,CAAA,MAAA;EAAA;;;;;;;;;;;;;;;;;;;;;KAWnB,kBAAA,UAA4B,kBAAA,CAAmB,IAAI;;cAGlD,mBAAA,EAAmB,MAAA,CAAA,MAAA;EAAA;;;;;;oCA3BC;EAAA,8BAAA;EAAA;;KAyCrB,mBAAA,UAA6B,mBAAA,CAAoB,IAAI;;;;;cAMpD,2BAAA,EAA2B,MAAA,CAAA,MAAA;EAAA;;;;;KAQ5B,2BAAA,UAAqC,2BAAA,CAA4B,IAAI;AAAA,cAEpE,sBAAA,EAAsB,MAAA,CAAA,MAAA;EAAA;;;;;;;;;;;;;;KAavB,sBAAA,UAAgC,sBAAA,CAAuB,IAAI;;cAG1D,wBAAA,EAAwB,MAAA,CAAA,MAAA;EAAA;;;;;;;KAUzB,wBAAA,UAAkC,wBAAA,CAAyB,IAAI;;;;;;cAO9D,yBAAA,EAAyB,MAAA,CAAA,MAAA;EAAA;;;;;;;;;;;;;KAK1B,yBAAA,UAAmC,yBAAA,CAA0B,IAAI;AAAA,cAIvE,QAAA,EAAQ,MAAA,CAAA,MAAA;EAtFiB,yGAyF7B,MAAA,CAAA,GAAA;AAAA;;cAGW,yBAAA,EAAyB,MAAA,CAAA,MAAA;EAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;IA9EN;;;;;;;KA6FpB,mBAAA;EACV,OAAA,EAAS,qBAAA;EACT,KAAA,EAAO,aAAA,CAAc,kBAAA;EACrB,YAAA,EAAc,aAAA,CAAc,yBAAA;EAC5B,MAAA,EAAQ,aAAA,CAAc,mBAAA;EACtB,aAAA,EAAe,aAAA,CAAc,2BAAA;EAC7B,SAAA,EAAW,aAAA,CAAc,sBAAA;EACzB,WAAA,EAAa,aAAA,CAAc,wBAAA;EAC3B,QAAA,SAAiB,QAAA,CAAS,IAAA;AAAA;;cAIf,qBAAA,EAAqB,MAAA,CAAA,QAAA;AAAA,KAEtB,qBAAA,UAA+B,qBAAA,CAAsB,IAAI;;;;;cAMxD,kBAAA,EAAkB,MAAA,CAAA,MAAA;EAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;sCArFnB;IAAA,8BAAqC;IAAA;;;oCAa/C;IAAA;;;;;;;;;;;;;;;;;;;;;wCAXiC;IAAA;;;;;;KA8FvB,kBAAA,UAA4B,kBAAA,CAAmB,IAAI;;cAYlD,aAAA,GAAiB,IAAA,aAAe,MAAA,CAAO,UAKlD;;cAGW,aAAA,GAAiB,KAAA,EAAO,aAAA,CAAc,MAAA,CAAO,IAAA,MAAQ,MAAA,CAAO,UAAA;;cAyR5D,cAAA,GAAkB,KAAA,cAAiB,mBAAmB;;cAStD,WAAA,GAAe,KAAA,cAAiB,mBAAmB"}