@notionhq/workers 0.0.82

package/dist/schema.d.ts

@@ -0,0 +1,178 @@
+import type { DateFormat, Icon, NumberFormat, SelectOption, StatusGroup } from "./types.js";
+/**
+ * Supported property types for sync schemas.
+ */
+export type PropertyType = "title" | "rich_text" | "url" | "email" | "phone_number" | "checkbox" | "file" | "number" | "date" | "select" | "multi_select" | "status" | "people" | "place";
+/**
+ * Definition of a single property in a sync schema.
+ */
+export type PropertyDefinition = {
+    type: PropertyType;
+};
+/**
+ * A schema defining the structure a single property in a data source.
+ */
+export type PropertyConfiguration = {
+    type: "title";
+} | {
+    type: "text";
+} | {
+    type: "url";
+} | {
+    type: "email";
+} | {
+    type: "phone_number";
+} | {
+    type: "checkbox";
+} | {
+    type: "file";
+} | {
+    type: "number";
+    format?: NumberFormat;
+} | {
+    type: "date";
+    date_format?: DateFormat;
+} | {
+    type: "select";
+    options: SelectOption[];
+} | {
+    type: "multi_select";
+    options: SelectOption[];
+} | {
+    type: "status";
+    groups: StatusGroup[];
+} | {
+    type: "people";
+} | {
+    type: "place";
+} | {
+    type: "relation";
+    /**
+     * The export name of the sync capability that defines the related collection.
+     * This must match the export name used when defining the related sync capability.
+     */
+    relatedSyncKey: string;
+    config: {
+        twoWay: false;
+    } | {
+        twoWay: true;
+        relatedPropertyName: string;
+    };
+};
+export type Schema<PK extends string> = {
+    /**
+     * The default name for the database when it is first created.
+     *
+     * Updating this after the database has been created will not change the
+     * name of the database.
+     */
+    defaultName: string;
+    /**
+     * Optional icon to use as the icon for the database page.
+     * If not provided, defaults to 📋.
+     * Use the `icon()` builder to create an icon value.
+     */
+    databaseIcon?: Icon;
+    properties: PropertySchema<PK>;
+    /**
+     * Optional configuration for sub-item relations.
+     * If provided, the parent and child properties must be part of a two-way self-relation.
+     */
+    subItems?: {
+        parentPropertyName: string;
+        childPropertyName: string;
+    };
+};
+/**
+ * A schema defining the structure of properties in a data source.
+ */
+export type PropertySchema<PK extends string> = {
+    [PrimaryKey in PK]: PropertyConfiguration;
+} & {
+    [propertyName: string]: PropertyConfiguration;
+};
+/**
+ * Creates a title property definition.
+ */
+export declare function title(): PropertyConfiguration;
+/**
+ * Creates a rich text property definition.
+ */
+export declare function richText(): PropertyConfiguration;
+/**
+ * Creates a URL property definition.
+ */
+export declare function url(): PropertyConfiguration;
+/**
+ * Creates an email property definition.
+ */
+export declare function email(): PropertyConfiguration;
+/**
+ * Creates a phone number property definition.
+ */
+export declare function phoneNumber(): PropertyConfiguration;
+/**
+ * Creates a checkbox property definition.
+ */
+export declare function checkbox(): PropertyConfiguration;
+/**
+ * Creates a file property definition.
+ */
+export declare function file(): PropertyConfiguration;
+/**
+ * Creates a number property definition with optional formatting.
+ */
+export declare function number(format?: NumberFormat): PropertyConfiguration;
+/**
+ * Creates a date property definition with optional formatting.
+ */
+export declare function date(date_format?: DateFormat): PropertyConfiguration;
+/**
+ * Creates a select property definition with predefined options.
+ */
+export declare function select(options: SelectOption[]): PropertyConfiguration;
+/**
+ * Creates a multi-select property definition with predefined options.
+ */
+export declare function multiSelect(options: SelectOption[]): PropertyConfiguration;
+/**
+ * Creates a status property definition with groups.
+ */
+export declare function status(config: {
+    groups: StatusGroup[];
+}): PropertyConfiguration;
+/**
+ * Creates a people property definition.
+ */
+export declare function people(): PropertyConfiguration;
+/**
+ * Creates a place property definition for storing geographic locations.
+ */
+export declare function place(): PropertyConfiguration;
+/**
+ * Creates a relation property definition that references another sync capability.
+ * The related collection must be defined by a sync capability in the same worker.
+ *
+ * @param relatedSyncKey - The export name of the sync capability that defines the related collection.
+ * @example
+ * ```typescript
+ * export const projectsSync = sync({...});
+ *
+ * export const tasksSync = sync({
+ *   schema: {
+ *     properties: {
+ *       "Task Title": Schema.title(),
+ *       "Project": Schema.relation("projectsSync"),
+ *     },
+ *   },
+ *   ...
+ * });
+ * ```
+ */
+export declare function relation(relatedSyncKey: string, config?: {
+    twoWay: false;
+} | {
+    twoWay: true;
+    relatedPropertyName: string;
+}): PropertyConfiguration;
+//# sourceMappingURL=schema.d.ts.map

package/dist/schema.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"schema.d.ts","sourceRoot":"","sources":["../src/schema.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACX,UAAU,EACV,IAAI,EACJ,YAAY,EACZ,YAAY,EACZ,WAAW,EACX,MAAM,YAAY,CAAC;AAEpB;;GAEG;AACH,MAAM,MAAM,YAAY,GACrB,OAAO,GACP,WAAW,GACX,KAAK,GACL,OAAO,GACP,cAAc,GACd,UAAU,GACV,MAAM,GACN,QAAQ,GACR,MAAM,GACN,QAAQ,GACR,cAAc,GACd,QAAQ,GACR,QAAQ,GACR,OAAO,CAAC;AAEX;;GAEG;AACH,MAAM,MAAM,kBAAkB,GAAG;IAChC,IAAI,EAAE,YAAY,CAAC;CACnB,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,qBAAqB,GAC9B;IAAE,IAAI,EAAE,OAAO,CAAA;CAAE,GACjB;IAAE,IAAI,EAAE,MAAM,CAAA;CAAE,GAChB;IAAE,IAAI,EAAE,KAAK,CAAA;CAAE,GACf;IAAE,IAAI,EAAE,OAAO,CAAA;CAAE,GACjB;IAAE,IAAI,EAAE,cAAc,CAAA;CAAE,GACxB;IAAE,IAAI,EAAE,UAAU,CAAA;CAAE,GACpB;IAAE,IAAI,EAAE,MAAM,CAAA;CAAE,GAChB;IACA,IAAI,EAAE,QAAQ,CAAC;IACf,MAAM,CAAC,EAAE,YAAY,CAAC;CACrB,GACD;IACA,IAAI,EAAE,MAAM,CAAC;IACb,WAAW,CAAC,EAAE,UAAU,CAAC;CACxB,GACD;IACA,IAAI,EAAE,QAAQ,CAAC;IACf,OAAO,EAAE,YAAY,EAAE,CAAC;CACvB,GACD;IACA,IAAI,EAAE,cAAc,CAAC;IACrB,OAAO,EAAE,YAAY,EAAE,CAAC;CACvB,GACD;IACA,IAAI,EAAE,QAAQ,CAAC;IACf,MAAM,EAAE,WAAW,EAAE,CAAC;CACrB,GACD;IAAE,IAAI,EAAE,QAAQ,CAAA;CAAE,GAClB;IAAE,IAAI,EAAE,OAAO,CAAA;CAAE,GACjB;IACA,IAAI,EAAE,UAAU,CAAC;IACjB;;;OAGG;IACH,cAAc,EAAE,MAAM,CAAC;IACvB,MAAM,EAAE;QAAE,MAAM,EAAE,KAAK,CAAA;KAAE,GAAG;QAAE,MAAM,EAAE,IAAI,CAAC;QAAC,mBAAmB,EAAE,MAAM,CAAA;KAAE,CAAC;CACzE,CAAC;AAEL,MAAM,MAAM,MAAM,CAAC,EAAE,SAAS,MAAM,IAAI;IACvC;;;;;OAKG;IACH,WAAW,EAAE,MAAM,CAAC;IACpB;;;;OAIG;IACH,YAAY,CAAC,EAAE,IAAI,CAAC;IACpB,UAAU,EAAE,cAAc,CAAC,EAAE,CAAC,CAAC;IAC/B;;;OAGG;IACH,QAAQ,CAAC,EAAE;QACV,kBAAkB,EAAE,MAAM,CAAC;QAC3B,iBAAiB,EAAE,MAAM,CAAC;KAC1B,CAAC;CACF,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,cAAc,CAAC,EAAE,SAAS,MAAM,IAAI;KAC9C,UAAU,IAAI,EAAE,GAAG,qBAAqB;CACzC,GAAG;IACH,CAAC,YAAY,EAAE,MAAM,GAAG,qBAAqB,CAAC;CAC9C,CAAC;AAEF;;GAEG;AACH,wBAAgB,KAAK,IAAI,qBAAqB,CAE7C;AAED;;GAEG;AACH,wBAAgB,QAAQ,IAAI,qBAAqB,CAEhD;AAED;;GAEG;AACH,wBAAgB,GAAG,IAAI,qBAAqB,CAE3C;AAED;;GAEG;AACH,wBAAgB,KAAK,IAAI,qBAAqB,CAE7C;AAED;;GAEG;AACH,wBAAgB,WAAW,IAAI,qBAAqB,CAEnD;AAED;;GAEG;AACH,wBAAgB,QAAQ,IAAI,qBAAqB,CAEhD;AAED;;GAEG;AACH,wBAAgB,IAAI,IAAI,qBAAqB,CAE5C;AAED;;GAEG;AACH,wBAAgB,MAAM,CAAC,MAAM,CAAC,EAAE,YAAY,GAAG,qBAAqB,CAEnE;AAED;;GAEG;AACH,wBAAgB,IAAI,CAAC,WAAW,CAAC,EAAE,UAAU,GAAG,qBAAqB,CAEpE;AAED;;GAEG;AACH,wBAAgB,MAAM,CAAC,OAAO,EAAE,YAAY,EAAE,GAAG,qBAAqB,CAErE;AAED;;GAEG;AACH,wBAAgB,WAAW,CAAC,OAAO,EAAE,YAAY,EAAE,GAAG,qBAAqB,CAE1E;AAED;;GAEG;AACH,wBAAgB,MAAM,CAAC,MAAM,EAAE;IAC9B,MAAM,EAAE,WAAW,EAAE,CAAC;CACtB,GAAG,qBAAqB,CAExB;AAED;;GAEG;AACH,wBAAgB,MAAM,IAAI,qBAAqB,CAE9C;AAED;;GAEG;AACH,wBAAgB,KAAK,IAAI,qBAAqB,CAE7C;AAED;;;;;;;;;;;;;;;;;;;GAmBG;AACH,wBAAgB,QAAQ,CACvB,cAAc,EAAE,MAAM,EACtB,MAAM,CAAC,EAAE;IAAE,MAAM,EAAE,KAAK,CAAA;CAAE,GAAG;IAAE,MAAM,EAAE,IAAI,CAAC;IAAC,mBAAmB,EAAE,MAAM,CAAA;CAAE,GACxE,qBAAqB,CAMvB"}

package/dist/schema.js

@@ -0,0 +1,66 @@
+function title() {
+  return { type: "title" };
+}
+function richText() {
+  return { type: "text" };
+}
+function url() {
+  return { type: "url" };
+}
+function email() {
+  return { type: "email" };
+}
+function phoneNumber() {
+  return { type: "phone_number" };
+}
+function checkbox() {
+  return { type: "checkbox" };
+}
+function file() {
+  return { type: "file" };
+}
+function number(format) {
+  return format ? { type: "number", format } : { type: "number" };
+}
+function date(date_format) {
+  return date_format ? { type: "date", date_format } : { type: "date" };
+}
+function select(options) {
+  return { type: "select", options };
+}
+function multiSelect(options) {
+  return { type: "multi_select", options };
+}
+function status(config) {
+  return { type: "status", groups: config.groups };
+}
+function people() {
+  return { type: "people" };
+}
+function place() {
+  return { type: "place" };
+}
+function relation(relatedSyncKey, config) {
+  return {
+    type: "relation",
+    relatedSyncKey,
+    config: config ?? { twoWay: false }
+  };
+}
+export {
+  checkbox,
+  date,
+  email,
+  file,
+  multiSelect,
+  number,
+  people,
+  phoneNumber,
+  place,
+  relation,
+  richText,
+  select,
+  status,
+  title,
+  url
+};

package/dist/types.d.ts

@@ -0,0 +1,206 @@
+/**
+ * A JSON value is a string, number, boolean, null, array, or object.
+ */
+export type JSONValue = string | number | boolean | null | JSONValue[] | {
+    [key: string]: JSONValue;
+};
+/**
+ * A text token is a tuple where the first element is the text content
+ * and optional subsequent elements are formatting annotations.
+ */
+type TextToken = [string, ...unknown[]];
+/**
+ * A TextValue is an array of text tokens, representing rich text content.
+ */
+export type TextValue = Array<TextToken>;
+/**
+ * Select option color types supported by Notion
+ */
+export type SelectColor = "default" | "gray" | "brown" | "orange" | "yellow" | "green" | "blue" | "purple" | "pink" | "red";
+/**
+ * A select option with an optional color
+ */
+export interface SelectOption {
+    name: string;
+    color?: SelectColor;
+}
+/**
+ * Status group types in Notion
+ */
+export type StatusGroupType = "To-do" | "In progress" | "Complete";
+/**
+ * Status group configuration
+ */
+export interface StatusGroup {
+    name: StatusGroupType;
+    options: SelectOption[];
+}
+/**
+ * Date object representing a single date without time
+ */
+export interface NotionDate {
+    type: "date";
+    start_date: string;
+}
+/**
+ * Date object representing a date with time
+ */
+export interface NotionDateTime {
+    type: "datetime";
+    start_date: string;
+    start_time: string;
+    time_zone?: string;
+}
+/**
+ * Date object representing a date range
+ */
+export interface DateRange {
+    type: "daterange";
+    start_date: string;
+    end_date: string;
+}
+/**
+ * Date object representing a date-time range
+ */
+export interface DateTimeRange {
+    type: "datetimerange";
+    start_date: string;
+    start_time: string;
+    end_date: string;
+    end_time: string;
+    time_zone?: string;
+}
+/**
+ * All possible date value types
+ */
+export type DateValue = NotionDate | NotionDateTime | DateRange | DateTimeRange;
+/**
+ * Number format types
+ */
+export type NumberFormat = "number" | "number_with_commas" | "percent" | "dollar" | "euro" | "pound" | "yen" | "rupee" | "won" | "yuan";
+/**
+ * Date format types
+ */
+export type DateFormat = "relative" | "MM/DD/YYYY" | "DD/MM/YYYY" | "YYYY/MM/DD" | "ll" | "MMM d";
+import type { NoticonName } from "./icon-names.js";
+/**
+ * Icon representing an emoji
+ */
+export interface EmojiIcon {
+    type: "emoji";
+    value: string;
+}
+/**
+ * Valid colors for Notion icons
+ */
+export type NoticonColor = "gray" | "lightgray" | "brown" | "yellow" | "orange" | "green" | "blue" | "purple" | "pink" | "red";
+/**
+ * Icon representing a Notion built-in icon
+ */
+export interface NoticonIcon {
+    type: "notion";
+    /**
+     * The name of the Notion icon (e.g., "checkmark", "pizza", "rocket")
+     */
+    icon: NoticonName;
+    /**
+     * The color variant of the icon
+     */
+    color: NoticonColor;
+}
+/**
+ * Icon representing an external image URL
+ */
+export interface ImageIcon {
+    type: "image";
+    /**
+     * The URL of the image (must be a valid http/https URL)
+     */
+    url: string;
+}
+/**
+ * All possible icon types
+ */
+export type Icon = EmojiIcon | NoticonIcon | ImageIcon;
+/**
+ * Person reference - represents a user in a people property
+ */
+export interface PersonReference {
+    /**
+     * The email address of the user
+     */
+    email: string;
+}
+/**
+ * A PeopleValue is an array of person references
+ */
+export type PeopleValue = PersonReference[];
+export type { NoticonName } from "./icon-names.js";
+/**
+ * Place value representing a geographic location.
+ * Used for place properties in databases.
+ */
+export interface PlaceValue {
+    /**
+     * Latitude coordinate (required)
+     */
+    lat: number;
+    /**
+     * Longitude coordinate (required)
+     */
+    lon: number;
+    /**
+     * Optional display name for the location
+     */
+    name?: string;
+    /**
+     * Optional street address
+     */
+    address?: string;
+    /**
+     * Optional Google Place ID for the location
+     */
+    googlePlaceId?: string;
+}
+/**
+ * A reference to a related record by its primary key.
+ */
+export type RelationReference = {
+    type: "primaryKey";
+    value: string;
+};
+/**
+ * Relation value representing references to related records.
+ * Each reference identifies a record in the target collection.
+ */
+export type RelationValue = RelationReference[];
+/**
+ * Time units for schedule intervals.
+ * - "m": minutes
+ * - "h": hours
+ * - "d": days
+ */
+export type TimeUnit = "m" | "h" | "d";
+/**
+ * A string representing an interval, e.g. "30m", "1h", "7d".
+ */
+export type IntervalString = `${number}${TimeUnit}`;
+/**
+ * Schedule configuration for sync capabilities.
+ * - "continuous": Run as frequently as the system allows
+ * - IntervalString: Run at specified intervals, e.g. "30m", "1h", "1d"
+ */
+export type Schedule = "continuous" | IntervalString;
+/**
+ * Normalized schedule representation stored in the backend.
+ */
+export type SyncSchedule = {
+    type: "continuous";
+} | {
+    type: "interval";
+    intervalMs: number;
+};
+export type HandlerOptions = {
+    concreteOutput?: true;
+};
+//# sourceMappingURL=types.d.ts.map

package/dist/types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,MAAM,MAAM,SAAS,GAClB,MAAM,GACN,MAAM,GACN,OAAO,GACP,IAAI,GACJ,SAAS,EAAE,GACX;IAAE,CAAC,GAAG,EAAE,MAAM,GAAG,SAAS,CAAA;CAAE,CAAC;AAEhC;;;GAGG;AACH,KAAK,SAAS,GAAG,CAAC,MAAM,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;AAExC;;GAEG;AACH,MAAM,MAAM,SAAS,GAAG,KAAK,CAAC,SAAS,CAAC,CAAC;AAEzC;;GAEG;AACH,MAAM,MAAM,WAAW,GACpB,SAAS,GACT,MAAM,GACN,OAAO,GACP,QAAQ,GACR,QAAQ,GACR,OAAO,GACP,MAAM,GACN,QAAQ,GACR,MAAM,GACN,KAAK,CAAC;AAET;;GAEG;AACH,MAAM,WAAW,YAAY;IAC5B,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,CAAC,EAAE,WAAW,CAAC;CACpB;AAED;;GAEG;AACH,MAAM,MAAM,eAAe,GAAG,OAAO,GAAG,aAAa,GAAG,UAAU,CAAC;AAEnE;;GAEG;AACH,MAAM,WAAW,WAAW;IAC3B,IAAI,EAAE,eAAe,CAAC;IACtB,OAAO,EAAE,YAAY,EAAE,CAAC;CACxB;AAED;;GAEG;AACH,MAAM,WAAW,UAAU;IAC1B,IAAI,EAAE,MAAM,CAAC;IACb,UAAU,EAAE,MAAM,CAAC;CACnB;AAED;;GAEG;AACH,MAAM,WAAW,cAAc;IAC9B,IAAI,EAAE,UAAU,CAAC;IACjB,UAAU,EAAE,MAAM,CAAC;IACnB,UAAU,EAAE,MAAM,CAAC;IACnB,SAAS,CAAC,EAAE,MAAM,CAAC;CACnB;AAED;;GAEG;AACH,MAAM,WAAW,SAAS;IACzB,IAAI,EAAE,WAAW,CAAC;IAClB,UAAU,EAAE,MAAM,CAAC;IACnB,QAAQ,EAAE,MAAM,CAAC;CACjB;AAED;;GAEG;AACH,MAAM,WAAW,aAAa;IAC7B,IAAI,EAAE,eAAe,CAAC;IACtB,UAAU,EAAE,MAAM,CAAC;IACnB,UAAU,EAAE,MAAM,CAAC;IACnB,QAAQ,EAAE,MAAM,CAAC;IACjB,QAAQ,EAAE,MAAM,CAAC;IACjB,SAAS,CAAC,EAAE,MAAM,CAAC;CACnB;AAED;;GAEG;AACH,MAAM,MAAM,SAAS,GAAG,UAAU,GAAG,cAAc,GAAG,SAAS,GAAG,aAAa,CAAC;AAEhF;;GAEG;AACH,MAAM,MAAM,YAAY,GACrB,QAAQ,GACR,oBAAoB,GACpB,SAAS,GACT,QAAQ,GACR,MAAM,GACN,OAAO,GACP,KAAK,GACL,OAAO,GACP,KAAK,GACL,MAAM,CAAC;AAEV;;GAEG;AACH,MAAM,MAAM,UAAU,GACnB,UAAU,GACV,YAAY,GACZ,YAAY,GACZ,YAAY,GACZ,IAAI,GACJ,OAAO,CAAC;AAEX,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,iBAAiB,CAAC;AAEnD;;GAEG;AACH,MAAM,WAAW,SAAS;IACzB,IAAI,EAAE,OAAO,CAAC;IACd,KAAK,EAAE,MAAM,CAAC;CACd;AAED;;GAEG;AACH,MAAM,MAAM,YAAY,GACrB,MAAM,GACN,WAAW,GACX,OAAO,GACP,QAAQ,GACR,QAAQ,GACR,OAAO,GACP,MAAM,GACN,QAAQ,GACR,MAAM,GACN,KAAK,CAAC;AAET;;GAEG;AACH,MAAM,WAAW,WAAW;IAC3B,IAAI,EAAE,QAAQ,CAAC;IACf;;OAEG;IACH,IAAI,EAAE,WAAW,CAAC;IAClB;;OAEG;IACH,KAAK,EAAE,YAAY,CAAC;CACpB;AAED;;GAEG;AACH,MAAM,WAAW,SAAS;IACzB,IAAI,EAAE,OAAO,CAAC;IACd;;OAEG;IACH,GAAG,EAAE,MAAM,CAAC;CACZ;AAED;;GAEG;AACH,MAAM,MAAM,IAAI,GAAG,SAAS,GAAG,WAAW,GAAG,SAAS,CAAC;AAEvD;;GAEG;AACH,MAAM,WAAW,eAAe;IAC/B;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;CACd;AAED;;GAEG;AACH,MAAM,MAAM,WAAW,GAAG,eAAe,EAAE,CAAC;AAE5C,YAAY,EAAE,WAAW,EAAE,MAAM,iBAAiB,CAAC;AAEnD;;;GAGG;AACH,MAAM,WAAW,UAAU;IAC1B;;OAEG;IACH,GAAG,EAAE,MAAM,CAAC;IACZ;;OAEG;IACH,GAAG,EAAE,MAAM,CAAC;IACZ;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IACd;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;CACvB;AAED;;GAEG;AACH,MAAM,MAAM,iBAAiB,GAAG;IAC/B,IAAI,EAAE,YAAY,CAAC;IACnB,KAAK,EAAE,MAAM,CAAC;CACd,CAAC;AAEF;;;GAGG;AACH,MAAM,MAAM,aAAa,GAAG,iBAAiB,EAAE,CAAC;AAEhD;;;;;GAKG;AACH,MAAM,MAAM,QAAQ,GAAG,GAAG,GAAG,GAAG,GAAG,GAAG,CAAC;AAEvC;;GAEG;AACH,MAAM,MAAM,cAAc,GAAG,GAAG,MAAM,GAAG,QAAQ,EAAE,CAAC;AAEpD;;;;GAIG;AACH,MAAM,MAAM,QAAQ,GAAG,YAAY,GAAG,cAAc,CAAC;AAErD;;GAEG;AACH,MAAM,MAAM,YAAY,GACrB;IAAE,IAAI,EAAE,YAAY,CAAA;CAAE,GACtB;IAAE,IAAI,EAAE,UAAU,CAAC;IAAC,UAAU,EAAE,MAAM,CAAA;CAAE,CAAC;AAE5C,MAAM,MAAM,cAAc,GAAG;IAC5B,cAAc,CAAC,EAAE,IAAI,CAAC;CACtB,CAAC"}

package/dist/worker.d.ts

@@ -0,0 +1,177 @@
+import type { AutomationCapability, AutomationConfiguration, AutomationEvent } from "./capabilities/automation.js";
+import type { CapabilityContext } from "./capabilities/context.js";
+import type { NotionManagedOAuthConfiguration, OAuthCapability, OAuthConfiguration, UserManagedOAuthConfiguration } from "./capabilities/oauth.js";
+import type { SyncCapability, SyncConfiguration } from "./capabilities/sync.js";
+import type { ToolCapability, ToolConfiguration } from "./capabilities/tool.js";
+import type { Schema } from "./schema.js";
+import type { HandlerOptions, JSONValue } from "./types.js";
+export type { AutomationConfiguration, AutomationEvent, CapabilityContext, OAuthConfiguration, NotionManagedOAuthConfiguration, UserManagedOAuthConfiguration, SyncConfiguration, ToolConfiguration, };
+type Capability = SyncCapability | ToolCapability<any, any> | AutomationCapability | OAuthCapability;
+export declare class Worker {
+    #private;
+    /**
+     * Register a sync capability.
+     *
+     * Example:
+     *
+     * ```ts
+     * import { Worker } from "@notionhq/workers-sdk";
+     * import * as Builder from "@notionhq/workers-sdk/builder";
+     * import * as Schema from "@notionhq/workers-sdk/schema";
+     *
+     * const worker = new Worker();
+     * export default worker;
+     *
+     * worker.sync("tasksSync", {
+     *   primaryKeyProperty: "Task ID",
+     *   schema: {
+     *     defaultName: "Tasks",
+     *     properties: {
+     *       "Task Name": Schema.title(),
+     *       "Task ID": Schema.richText(),
+     *       Status: Schema.select([
+     *         { name: "Open", color: "default" },
+     *         { name: "Done", color: "green" },
+     *       ]),
+     *     },
+     *   },
+     *   execute: async () => {
+     *     const changes = [
+     *       {
+     *         key: "task-1",
+     *         properties: {
+     *           "Task Name": Builder.title("Write docs"),
+     *           "Task ID": Builder.richText("task-1"),
+     *           Status: Builder.select("Open"),
+     *         },
+     *       },
+     *     ];
+     *
+     *     return { changes, hasMore: false };
+     *   },
+     * });
+     * ```
+     *
+     * @param key - The unique key for this capability.
+     * @param config - The sync configuration.
+     * @returns The capability object.
+     */
+    sync<PK extends string, S extends Schema<PK>, Context = unknown>(key: string, config: SyncConfiguration<PK, S, Context>): SyncCapability;
+    /**
+     * Register a tool capability.
+     *
+     * Example:
+     *
+     * ```ts
+     * worker.tool<{ name: string }, string>("sayHello", {
+     *   title: "Say Hello",
+     *   description: "Say hello to the user",
+     *   schema: {
+     *     type: "object",
+     *     properties: {
+     *       name: { type: "string" },
+     *     },
+     *     required: ["name"],
+     *   },
+     *   execute: ({ name }, { notion }) => {
+     *     return `Hello, ${name}!`;
+     *   },
+     * })
+     * ```
+     *
+     *
+     * @param key - The unique key for this capability.
+     * @param config - The tool configuration.
+     * @returns The capability object.
+     */
+    tool<I extends JSONValue, O extends JSONValue = JSONValue>(key: string, config: ToolConfiguration<I, O>): ToolCapability<I, O>;
+    /**
+     * Register an automation capability.
+     *
+     * Example:
+     *
+     * ```ts
+     * const worker = new Worker();
+     * export default worker;
+     *
+     * worker.automation("sendWelcomeEmail", {
+     *   title: "Send Welcome Email",
+     *   description: "Sends a welcome email when a new user is added",
+     *   execute: async (event, { notion }) => {
+     *     const { pageId, pageData } = event;
+     *
+     *     // Access page properties from the Public API format
+     *     if (pageData) {
+     *       const name = pageData.properties.Name; // Access any property
+     *       const status = pageData.properties.Status;
+     *       console.log(`Processing: ${name}`);
+     *     }
+     *
+     *     // Your automation logic here
+     *     await sendEmail(pageId);
+     *   },
+     * })
+     * ```
+     *
+     * @param key - The unique key for this capability.
+     * @param config - The automation configuration.
+     * @returns The capability object.
+     */
+    automation(key: string, config: AutomationConfiguration): AutomationCapability;
+    /**
+     * Register an OAuth capability.
+     *
+     * There are two ways to configure OAuth:
+     *
+     * 1. Notion-managed providers:
+     * ```ts
+     * const worker = new Worker();
+     * export default worker;
+     *
+     * worker.oauth("googleAuth", {
+     *   type: "notion_managed",
+     *   name: "my-google-auth",
+     *   provider: "google"
+     * })
+     * ```
+     *
+     * 2. User-managed OAuth configuration:
+     * ```ts
+     * const worker = new Worker();
+     * export default worker;
+     *
+     * worker.oauth("myCustomAuth", {
+     *   type: "user_managed",
+     *   name: "my-custom-oauth",
+     *   authorizationEndpoint: "https://provider.com/oauth/authorize",
+     *   tokenEndpoint: "https://provider.com/oauth/token",
+     *   scope: "read write",
+     *   clientId: process.env.CLIENT_ID,
+     *   clientSecret: process.env.CLIENT_SECRET,
+     *   authorizationParams: {
+     *     access_type: "offline",
+     *     prompt: "consent"
+     *   }
+     * })
+     * ```
+     *
+     * @param key - The unique key used to register this OAuth capability.
+     * @param config - The OAuth configuration (Notion-managed or user-managed) for this capability.
+     * @returns The registered OAuth capability.
+     */
+    oauth(key: string, config: OAuthConfiguration): OAuthCapability;
+    /**
+     * Get all registered capabilities (for discovery) without their handlers.
+     */
+    get capabilities(): Pick<Capability, "_tag" | "key" | "config">[];
+    /**
+     * Execute a capability by key.
+     *
+     * @param key - The key of the capability to execute.
+     * @param context - The context to pass to the capability.
+     * @param options - Additional options for execution (e.g. for testing).
+     * @returns The result of the capability execution.
+     */
+    run(key: string, context: unknown, options?: HandlerOptions): Promise<unknown>;
+}
+//# sourceMappingURL=worker.d.ts.map

package/dist/worker.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"worker.d.ts","sourceRoot":"","sources":["../src/worker.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACX,oBAAoB,EACpB,uBAAuB,EACvB,eAAe,EACf,MAAM,8BAA8B,CAAC;AAEtC,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,2BAA2B,CAAC;AACnE,OAAO,KAAK,EACX,+BAA+B,EAC/B,eAAe,EACf,kBAAkB,EAClB,6BAA6B,EAC7B,MAAM,yBAAyB,CAAC;AAEjC,OAAO,KAAK,EAAE,cAAc,EAAE,iBAAiB,EAAE,MAAM,wBAAwB,CAAC;AAEhF,OAAO,KAAK,EAAE,cAAc,EAAE,iBAAiB,EAAE,MAAM,wBAAwB,CAAC;AAEhF,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,aAAa,CAAC;AAC1C,OAAO,KAAK,EAAE,cAAc,EAAE,SAAS,EAAE,MAAM,YAAY,CAAC;AAG5D,YAAY,EACX,uBAAuB,EACvB,eAAe,EACf,iBAAiB,EACjB,kBAAkB,EAClB,+BAA+B,EAC/B,6BAA6B,EAC7B,iBAAiB,EACjB,iBAAiB,GACjB,CAAC;AAMF,KAAK,UAAU,GACZ,cAAc,GAEd,cAAc,CAAC,GAAG,EAAE,GAAG,CAAC,GACxB,oBAAoB,GACpB,eAAe,CAAC;AAMnB,qBAAa,MAAM;;IAGlB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA8CG;IACH,IAAI,CAAC,EAAE,SAAS,MAAM,EAAE,CAAC,SAAS,MAAM,CAAC,EAAE,CAAC,EAAE,OAAO,GAAG,OAAO,EAC9D,GAAG,EAAE,MAAM,EACX,MAAM,EAAE,iBAAiB,CAAC,EAAE,EAAE,CAAC,EAAE,OAAO,CAAC,GACvC,cAAc;IAOjB;;;;;;;;;;;;;;;;;;;;;;;;;;OA0BG;IACH,IAAI,CAAC,CAAC,SAAS,SAAS,EAAE,CAAC,SAAS,SAAS,GAAG,SAAS,EACxD,GAAG,EAAE,MAAM,EACX,MAAM,EAAE,iBAAiB,CAAC,CAAC,EAAE,CAAC,CAAC,GAC7B,cAAc,CAAC,CAAC,EAAE,CAAC,CAAC;IAQvB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA+BG;IACH,UAAU,CACT,GAAG,EAAE,MAAM,EACX,MAAM,EAAE,uBAAuB,GAC7B,oBAAoB;IAOvB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAwCG;IACH,KAAK,CAAC,GAAG,EAAE,MAAM,EAAE,MAAM,EAAE,kBAAkB,GAAG,eAAe;IAO/D;;OAEG;IACH,IAAI,YAAY,IAAI,IAAI,CAAC,UAAU,EAAE,MAAM,GAAG,KAAK,GAAG,QAAQ,CAAC,EAAE,CAMhE;IAED;;;;;;;OAOG;IACG,GAAG,CACR,GAAG,EAAE,MAAM,EACX,OAAO,EAAE,OAAO,EAChB,OAAO,GAAE,cAAmB,GAC1B,OAAO,CAAC,OAAO,CAAC;CAyBnB"}