@notionhq/apps 0.0.16 → 0.0.18

package/dist/notion-as-code/views.d.ts

@@ -0,0 +1,488 @@
+import type { NotionAsCodeIcon, NotionAsCodeProperty, ResourceId } from "./intents.js";
+export type ViewType = "table" | "board" | "calendar" | "list" | "gallery" | "feed" | "timeline";
+export type PropertyVisibility = "show" | "hide" | "hide_if_empty";
+/**
+ * Format for a single visible property entry in a view (table / board / list /
+ * gallery / feed / timeline).
+ *
+ * `property` must be the `resourceId` of a property in the view's data
+ * source, matching the same convention used by board `groupBy.property`,
+ * `calendarBy`, and `timelineBy`.
+ *
+ */
+export type PropertyFormat = {
+    /** ResourceId of the property in the view's data source. */
+    property: ResourceId;
+    visible?: boolean;
+    width?: number;
+    visibility?: PropertyVisibility;
+};
+/**
+ * Format for a single column entry in a board view.
+ *
+ * `property` must be the `resourceId` of a property in the view's data
+ * source, matching the same convention used by `PropertyFormat.property`
+ * and board `groupBy.property`.
+ *
+ */
+export type GroupFormat = {
+    /** ResourceId of the property in the view's data source. */
+    property: ResourceId;
+    hidden?: boolean;
+    value?: {
+        type: string;
+        value?: string | boolean | number | null;
+    };
+};
+export type GroupByFormatBase = {
+    /** ResourceId of the property in the view's data source. */
+    property: ResourceId;
+    /** Whether groups with no pages are visible. Defaults to "show". */
+    emptyGroupVisibility?: "show" | "hide";
+    statusBy?: never;
+};
+export type SelectGroupByFormat = GroupByFormatBase & {
+    type: "select" | "multi_select";
+};
+export type StatusGroupByFormat = Omit<GroupByFormatBase, "statusBy"> & {
+    type: "status";
+    /** Groups status values by their canonical status group or individual option. */
+    statusBy?: "group" | "option";
+};
+export type PersonGroupByFormat = GroupByFormatBase & {
+    type: "person" | "created_by" | "last_edited_by";
+};
+export type DateGroupByFormat = GroupByFormatBase & {
+    type: "date" | "created_time" | "last_edited_time" | "last_visited_time";
+};
+export type TextGroupByFormat = GroupByFormatBase & {
+    type: "text" | "title" | "url" | "email" | "phone_number";
+};
+export type NumberGroupByFormat = GroupByFormatBase & {
+    type: "number";
+};
+export type CheckboxGroupByFormat = GroupByFormatBase & {
+    type: "checkbox";
+};
+export type RelationGroupByFormat = GroupByFormatBase & {
+    type: "relation";
+};
+export type LocationGroupByFormat = GroupByFormatBase & {
+    type: "location";
+};
+export type FormulaGroupByFormat = GroupByFormatBase & {
+    type: "formula";
+};
+/**
+ * Board view group-by configuration.
+ *
+ * `property` must be the `resourceId` of a property in the view's data
+ * source, matching the same convention used by `PropertyFormat.property`,
+ * `CalendarViewSchema.calendarBy`, and `TimelineViewSchema.timelineBy`.
+ *
+ */
+export type GroupByFormat = SelectGroupByFormat | StatusGroupByFormat | PersonGroupByFormat | DateGroupByFormat | TextGroupByFormat | NumberGroupByFormat | CheckboxGroupByFormat | RelationGroupByFormat | LocationGroupByFormat | FormulaGroupByFormat;
+export type CoverFormat = {
+    type: "page_cover";
+} | {
+    type: "page_content";
+} | {
+    type: "page_content_first";
+} | {
+    type: "property";
+    property: string;
+};
+export type CoverSizeFormat = "small" | "medium" | "large";
+export type CoverAspectFormat = "contain" | "cover";
+export type DatabaseViewSortDirection = "ascending" | "descending";
+/**
+ * Sort schema for ordering database view results.
+ * Sorts are applied in order — all pages are first sorted by the first sort,
+ * then ties are broken by the second sort, and so on.
+ */
+export type PropertyViewSortSchema = {
+    propertyId: string;
+    direction: DatabaseViewSortDirection;
+};
+type PropertyType = NotionAsCodeProperty["type"];
+export type DatePropertyTypes = "date" | "created_time" | "last_edited_time";
+export type BasePropertyFilter = {
+    propertyId: string;
+    type: "property";
+};
+export type TextPropertyFilter = {
+    propertyType: Extract<PropertyType, "text" | "title" | "url" | "email" | "phone_number">;
+    operator: "string_is" | "string_is_not" | "string_contains" | "string_does_not_contain" | "string_starts_with" | "string_ends_with";
+    value: string;
+} & BasePropertyFilter;
+export type NumberPropertyFilter = {
+    propertyType: Extract<PropertyType, "number">;
+    operator: "number_equals" | "number_does_not_equal" | "number_greater_than" | "number_less_than" | "number_greater_than_or_equal_to" | "number_less_than_or_equal_to";
+    value: number;
+} & BasePropertyFilter;
+export type CheckboxPropertyFilter = {
+    propertyType: Extract<PropertyType, "checkbox">;
+    operator: "checkbox_is" | "checkbox_is_not";
+    value: boolean;
+} & BasePropertyFilter;
+export type SelectPropertyFilter = {
+    propertyType: Extract<PropertyType, "select">;
+    operator: "enum_is" | "enum_is_not";
+    value: Array<string>;
+} & BasePropertyFilter;
+export type MultiSelectPropertyFilter = {
+    propertyType: Extract<PropertyType, "multi_select">;
+    operator: "enum_contains" | "enum_does_not_contain" | "enum_contains_all";
+    value: Array<string>;
+} & BasePropertyFilter;
+export type StatusPropertyFilter = {
+    propertyType: Extract<PropertyType, "status">;
+    operator: "status_is" | "status_is_not";
+    value: Array<string>;
+} & BasePropertyFilter;
+/**
+ * Date presets resolved relative to today, matching options such as
+ * "Today", "Tomorrow", and "One week ago".
+ */
+export type RelativeDatePreset = "today" | "tomorrow" | "yesterday" | "one_week_ago" | "one_week_from_now" | "one_month_ago" | "one_month_from_now";
+/**
+ * The unit spanned by a relative "is relative to today" date range.
+ */
+export type RelativeDateRangeUnit = "day" | "week" | "month" | "year";
+/**
+ * Which date a date property filter compares against. Notion date properties
+ * can hold a range, and `end_date` reads the far end of it.
+ */
+export type DateFilterMode = "start_date" | "end_date";
+export type ExactDatePropertyFilterValue = {
+    type: "exact";
+    value: string;
+};
+export type RelativeDatePropertyFilterValue = {
+    type: "relative";
+    value: RelativeDatePreset;
+};
+export type RelativeToTodayDatePropertyFilterValue = {
+    type: "relative_to_today";
+    value: {
+        direction: "past" | "next" | "this";
+        count?: number;
+        unit: RelativeDateRangeUnit;
+    };
+};
+/**
+ * Value for the `date_is_within` operator, shown as "Is between" in the UI.
+ *
+ * Bounds are inclusive `YYYY-MM-DD` dates; supplying only one leaves the range
+ * open at the other end.
+ *
+ */
+export type ExactRangeDatePropertyFilterValue = {
+    type: "exact_range";
+    value: {
+        startDate: string;
+        endDate?: string;
+    } | {
+        startDate?: string;
+        endDate: string;
+    };
+};
+/**
+ * Value for a date property filter.
+ *
+ * - `exact` matches a calendar date in `YYYY-MM-DD` format.
+ * - `relative` matches a date preset such as today or tomorrow.
+ * - `relative_to_today` matches a range relative to today. `unit` can be
+ *   `day`, `week`, `month`, or `year`. `count` defaults to `1` when omitted
+ *   and is unnecessary for `direction: "this"`.
+ * - `exact_range` matches a fixed calendar range, optionally open at one end.
+ *
+ */
+export type DatePropertyFilterValue = ExactDatePropertyFilterValue | RelativeDatePropertyFilterValue | RelativeToTodayDatePropertyFilterValue | ExactRangeDatePropertyFilterValue;
+/**
+ * Date property filter.
+ *
+ * Single-date operators accept `exact` or `relative` values.
+ * `date_is_relative_to` requires a `relative_to_today` value.
+ * `date_is_within` requires an `exact_range` value.
+ *
+ * `dateFilterMode` chooses which end of a date range the comparison reads.
+ * It defaults to `"start_date"`. `"end_date"` falls back to the start date for
+ * rows whose date is a single day rather than a range, and has no effect on
+ * `created_time` / `last_edited_time` properties, which are never ranges.
+ *
+ * @example Exact date
+ * {
+ *   type: "property",
+ *   propertyId: "due",
+ *   propertyType: "date",
+ *   operator: "date_is_on_or_after",
+ *   value: { type: "exact", value: "2025-10-03" }
+ * }
+ *
+ * @example Relative date preset
+ * {
+ *   type: "property",
+ *   propertyId: "due",
+ *   propertyType: "date",
+ *   operator: "date_is",
+ *   value: { type: "relative", value: "today" }
+ * }
+ *
+ * @example Next two months
+ * {
+ *   type: "property",
+ *   propertyId: "due",
+ *   propertyType: "date",
+ *   operator: "date_is_relative_to",
+ *   value: { type: "relative_to_today", value: { direction: "next", count: 2, unit: "month" } }
+ * }
+ *
+ * @example Sprints that end this week
+ * {
+ *   type: "property",
+ *   propertyId: "sprint",
+ *   propertyType: "date",
+ *   operator: "date_is_relative_to",
+ *   value: { type: "relative_to_today", value: { direction: "this", unit: "week" } },
+ *   dateFilterMode: "end_date"
+ * }
+ *
+ * @example Fixed calendar range
+ * {
+ *   type: "property",
+ *   propertyId: "due",
+ *   propertyType: "date",
+ *   operator: "date_is_within",
+ *   value: { type: "exact_range", value: { startDate: "2026-01-01", endDate: "2026-03-31" } }
+ * }
+ *
+ * @example Range left open at the end
+ * {
+ *   type: "property",
+ *   propertyId: "due",
+ *   propertyType: "date",
+ *   operator: "date_is_within",
+ *   value: { type: "exact_range", value: { startDate: "2026-01-01" } }
+ * }
+ *
+ */
+export type DatePropertyFilter = ({
+    propertyType: DatePropertyTypes;
+    operator: "date_is" | "date_is_before" | "date_is_after" | "date_is_on_or_before" | "date_is_on_or_after";
+    value: ExactDatePropertyFilterValue | RelativeDatePropertyFilterValue;
+    dateFilterMode?: DateFilterMode;
+} & BasePropertyFilter) | ({
+    propertyType: DatePropertyTypes;
+    operator: "date_is_relative_to";
+    value: RelativeToTodayDatePropertyFilterValue;
+    dateFilterMode?: DateFilterMode;
+} & BasePropertyFilter) | ({
+    propertyType: DatePropertyTypes;
+    operator: "date_is_within";
+    value: ExactRangeDatePropertyFilterValue;
+    dateFilterMode?: DateFilterMode;
+} & BasePropertyFilter);
+export type RelationPropertyFilter = {
+    propertyType: Extract<PropertyType, "relation">;
+    operator: "relation_contains" | "relation_does_not_contain";
+    /** References related pages, or the current page when rendered as a page-layout tab. */
+    value: {
+        type: "exact";
+        value: Array<ResourceId>;
+    } | {
+        type: "relative";
+        value: "this_page";
+    };
+} & BasePropertyFilter;
+/**
+ * Person property filter — matches rows whose person property contains (or
+ * does not contain) the viewer (the `"me"` template variable, resolved at
+ * read time).
+ */
+export type PersonPropertyFilter = {
+    propertyType: Extract<PropertyType, "person" | "created_by" | "last_edited_by">;
+    operator: "person_contains" | "person_does_not_contain";
+    value: [{
+        type: "relative";
+        value: "me";
+    }];
+} & BasePropertyFilter;
+/**
+ * Filter schema for filtering database views by property values.
+ * Used in view definitions to specify which pages should be visible.
+ *
+ * Each filter targets a specific property by ID and applies a type-appropriate
+ * filter operator with a comparison value.
+ *
+ * @example Text property filter
+ * {
+ *   propertyId: "name-prop",
+ *   type: "property",
+ *   propertyType: "text",
+ *   operator: "string_contains",
+ *   value: "Project"
+ * }
+ */
+export type PropertyFilterSchema = TextPropertyFilter | NumberPropertyFilter | CheckboxPropertyFilter | SelectPropertyFilter | MultiSelectPropertyFilter | StatusPropertyFilter | DatePropertyFilter | RelationPropertyFilter | PersonPropertyFilter;
+export type FilterSchema = Array<PropertyFilterSchema | AdvancedFilterSchema>;
+export type AdvancedFilterSchema = {
+    type: "advanced";
+    operator: "and" | "or";
+    filters: FilterSchema;
+};
+/**
+ * Base view schema shared by all view types.
+ *
+ * `dataSourceResourceId` must reference a data source created by the script or
+ * supplied through existing resources.
+ *
+ * Database declarations require at least one data source or at least one view.
+ * A linked-only database may omit `datasources`, or use `datasources: {}`, only
+ * when its `views` list is nonempty. `{}`, `{ datasources: {} }`, and
+ * `{ datasources: {}, views: [] }` are invalid.
+ *
+ * @example
+ * // A linked-only database can use a typed table view for an explicit source.
+ * const linkedTableView: TableViewSchema = {
+ *   resourceId: "issues-table-view",
+ *   type: "table",
+ *   dataSourceResourceId: "issues-source",
+ *   properties: [{ property: "issue-title", visible: true }]
+ * };
+ * const linkedDatabase = notion.database("issues-linked-database", {
+ *   parent: { type: "resourceId", resourceId: "project-page" },
+ *   views: [linkedTableView]
+ * })
+ *
+ * @example
+ * // When creating a database with a data source
+ * const db = notion.database("my-database", {
+ *   dataSourceResourceId: "my-datasource",
+ *   name: "Main",
+ *   schema: { Name: { resourceId: "my-title", type: "title" } }
+ * })
+ *
+ * // Views must reference that data source
+ * db.addView({
+ *   resourceId: "my-table-view",
+ *   type: "table",
+ *   dataSourceResourceId: "my-datasource"  // REQUIRED: matches data source above
+ * })
+ *
+ * @example
+ * // The explicit empty `datasources` form is valid with a nonempty view list.
+ * const explicitLinkedDatabase = notion.database("issues-linked-database-explicit", {
+ *   datasources: {},
+ *   views: [{
+ *     resourceId: "issues-table-view-explicit",
+ *     type: "table",
+ *     dataSourceResourceId: "issues-source",
+ *     properties: [{ property: "issue-title", visible: true }]
+ *   }]
+ * })
+ */
+export type BaseViewSchema = {
+    resourceId: ResourceId;
+    name?: string;
+    /**
+     * Notion icon shown in the view tab, including tabs in database page layouts.
+     * View icons do not support emoji or uploaded files. Omit to use the default
+     * icon for the view type.
+     */
+    icon?: Extract<NotionAsCodeIcon, {
+        type: "notion_icon";
+    }>;
+    type: ViewType;
+    /** Resource ID of a script-created or existing data source. */
+    dataSourceResourceId: ResourceId;
+    /**
+     * Optional resource ID of a template page in this view's data source to use as
+     * the view default template.
+     *
+     * The referenced page must be created with `template: true` and be parented to
+     * this same data source.
+     */
+    defaultTemplate?: ResourceId;
+    /**
+     * Optional: create this view as a linked view referenced by `<database>` tags
+     * in page content markdown or use it as a tab in a database layout. It does
+     * not attach to the database block's main view tabs.
+     */
+    ephemeral?: boolean;
+    sorts?: Array<PropertyViewSortSchema>;
+    /** Optional filter to control which pages appear in this view. */
+    filters?: FilterSchema;
+    /** Whether page icons are shown in this view. */
+    showPageIcon?: boolean;
+};
+export type TableViewSchema = BaseViewSchema & {
+    type: "table";
+    properties?: Array<PropertyFormat>;
+    wrap?: boolean;
+    groupBy?: GroupByFormat;
+};
+export type BoardViewSchema = BaseViewSchema & {
+    type: "board";
+    properties?: Array<PropertyFormat>;
+    groupBy?: GroupByFormat;
+    columns?: Array<GroupFormat>;
+    cover?: CoverFormat;
+    coverSize?: CoverSizeFormat;
+    coverAspect?: CoverAspectFormat;
+    wrap?: boolean;
+};
+export type CalendarViewSchema = BaseViewSchema & {
+    type: "calendar";
+    properties?: Array<PropertyFormat>;
+    /**
+     * REQUIRED: ResourceId of the date property to use for the calendar.
+     * Must match the `resourceId` of a date property in the database schema.
+     *
+     * @example
+     * calendarBy: "due-date-prop"  // resourceId of a property of type "date"
+     */
+    calendarBy: ResourceId;
+    showWeekends?: boolean;
+};
+export type ListViewSchema = BaseViewSchema & {
+    type: "list";
+    properties?: Array<PropertyFormat>;
+    groupBy?: GroupByFormat;
+};
+export type GalleryViewSchema = BaseViewSchema & {
+    type: "gallery";
+    properties?: Array<PropertyFormat>;
+    cover?: CoverFormat;
+    coverSize?: CoverSizeFormat;
+    coverAspect?: CoverAspectFormat;
+};
+export type FeedViewSchema = BaseViewSchema & {
+    type: "feed";
+    properties?: Array<PropertyFormat>;
+    wrap?: boolean;
+    showAuthorByline?: boolean;
+};
+export type TimelineViewSchema = BaseViewSchema & {
+    type: "timeline";
+    properties?: Array<PropertyFormat>;
+    tableProperties?: Array<PropertyFormat>;
+    /**
+     * REQUIRED: ResourceId of the date property to use for the timeline start.
+     * Must match the `resourceId` of a date property in the database schema.
+     *
+     * @example
+     * timelineBy: "start-date-prop"  // resourceId of a property of type "date"
+     */
+    timelineBy: ResourceId;
+    /**
+     * Optional: ResourceId of the date property to use for the timeline end
+     * (for date ranges). Must match the `resourceId` of a date property in
+     * the database schema.
+     */
+    timelineByEnd?: ResourceId;
+    showTable?: boolean;
+};
+export type ViewSchema = TableViewSchema | BoardViewSchema | CalendarViewSchema | ListViewSchema | GalleryViewSchema | FeedViewSchema | TimelineViewSchema;
+export {};
+//# sourceMappingURL=views.d.ts.map

package/dist/notion-as-code/views.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"views.d.ts","sourceRoot":"","sources":["../../src/notion-as-code/views.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,gBAAgB,EAAE,oBAAoB,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC;AAGvF,MAAM,MAAM,QAAQ,GAAG,OAAO,GAAG,OAAO,GAAG,UAAU,GAAG,MAAM,GAAG,SAAS,GAAG,MAAM,GAAG,UAAU,CAAC;AAEjG,MAAM,MAAM,kBAAkB,GAAG,MAAM,GAAG,MAAM,GAAG,eAAe,CAAC;AAEnE;;;;;;;;GAQG;AACH,MAAM,MAAM,cAAc,GAAG;IAC5B,4DAA4D;IAC5D,QAAQ,EAAE,UAAU,CAAC;IACrB,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,UAAU,CAAC,EAAE,kBAAkB,CAAC;CAChC,CAAC;AAEF;;;;;;;GAOG;AACH,MAAM,MAAM,WAAW,GAAG;IACzB,4DAA4D;IAC5D,QAAQ,EAAE,UAAU,CAAC;IACrB,MAAM,CAAC,EAAE,OAAO,CAAC;IACjB,KAAK,CAAC,EAAE;QACP,IAAI,EAAE,MAAM,CAAC;QACb,KAAK,CAAC,EAAE,MAAM,GAAG,OAAO,GAAG,MAAM,GAAG,IAAI,CAAC;KACzC,CAAC;CACF,CAAC;AAEF,MAAM,MAAM,iBAAiB,GAAG;IAC/B,4DAA4D;IAC5D,QAAQ,EAAE,UAAU,CAAC;IACrB,oEAAoE;IACpE,oBAAoB,CAAC,EAAE,MAAM,GAAG,MAAM,CAAC;IACvC,QAAQ,CAAC,EAAE,KAAK,CAAC;CACjB,CAAC;AAEF,MAAM,MAAM,mBAAmB,GAAG,iBAAiB,GAAG;IACrD,IAAI,EAAE,QAAQ,GAAG,cAAc,CAAC;CAChC,CAAC;AAEF,MAAM,MAAM,mBAAmB,GAAG,IAAI,CAAC,iBAAiB,EAAE,UAAU,CAAC,GAAG;IACvE,IAAI,EAAE,QAAQ,CAAC;IACf,iFAAiF;IACjF,QAAQ,CAAC,EAAE,OAAO,GAAG,QAAQ,CAAC;CAC9B,CAAC;AAEF,MAAM,MAAM,mBAAmB,GAAG,iBAAiB,GAAG;IACrD,IAAI,EAAE,QAAQ,GAAG,YAAY,GAAG,gBAAgB,CAAC;CACjD,CAAC;AAEF,MAAM,MAAM,iBAAiB,GAAG,iBAAiB,GAAG;IACnD,IAAI,EAAE,MAAM,GAAG,cAAc,GAAG,kBAAkB,GAAG,mBAAmB,CAAC;CACzE,CAAC;AAEF,MAAM,MAAM,iBAAiB,GAAG,iBAAiB,GAAG;IACnD,IAAI,EAAE,MAAM,GAAG,OAAO,GAAG,KAAK,GAAG,OAAO,GAAG,cAAc,CAAC;CAC1D,CAAC;AAEF,MAAM,MAAM,mBAAmB,GAAG,iBAAiB,GAAG;IACrD,IAAI,EAAE,QAAQ,CAAC;CACf,CAAC;AAEF,MAAM,MAAM,qBAAqB,GAAG,iBAAiB,GAAG;IACvD,IAAI,EAAE,UAAU,CAAC;CACjB,CAAC;AAEF,MAAM,MAAM,qBAAqB,GAAG,iBAAiB,GAAG;IACvD,IAAI,EAAE,UAAU,CAAC;CACjB,CAAC;AAEF,MAAM,MAAM,qBAAqB,GAAG,iBAAiB,GAAG;IACvD,IAAI,EAAE,UAAU,CAAC;CACjB,CAAC;AAEF,MAAM,MAAM,oBAAoB,GAAG,iBAAiB,GAAG;IACtD,IAAI,EAAE,SAAS,CAAC;CAChB,CAAC;AAEF;;;;;;;GAOG;AACH,MAAM,MAAM,aAAa,GACtB,mBAAmB,GACnB,mBAAmB,GACnB,mBAAmB,GACnB,iBAAiB,GACjB,iBAAiB,GACjB,mBAAmB,GACnB,qBAAqB,GACrB,qBAAqB,GACrB,qBAAqB,GACrB,oBAAoB,CAAC;AAExB,MAAM,MAAM,WAAW,GACpB;IAAE,IAAI,EAAE,YAAY,CAAA;CAAE,GACtB;IAAE,IAAI,EAAE,cAAc,CAAA;CAAE,GACxB;IAAE,IAAI,EAAE,oBAAoB,CAAA;CAAE,GAC9B;IAAE,IAAI,EAAE,UAAU,CAAC;IAAC,QAAQ,EAAE,MAAM,CAAA;CAAE,CAAC;AAE1C,MAAM,MAAM,eAAe,GAAG,OAAO,GAAG,QAAQ,GAAG,OAAO,CAAC;AAE3D,MAAM,MAAM,iBAAiB,GAAG,SAAS,GAAG,OAAO,CAAC;AAEpD,MAAM,MAAM,yBAAyB,GAAG,WAAW,GAAG,YAAY,CAAC;AAEnE;;;;GAIG;AACH,MAAM,MAAM,sBAAsB,GAAG;IACpC,UAAU,EAAE,MAAM,CAAC;IACnB,SAAS,EAAE,yBAAyB,CAAC;CACrC,CAAC;AAEF,KAAK,YAAY,GAAG,oBAAoB,CAAC,MAAM,CAAC,CAAC;AAEjD,MAAM,MAAM,iBAAiB,GAAG,MAAM,GAAG,cAAc,GAAG,kBAAkB,CAAC;AAE7E,MAAM,MAAM,kBAAkB,GAAG;IAChC,UAAU,EAAE,MAAM,CAAC;IACnB,IAAI,EAAE,UAAU,CAAC;CACjB,CAAC;AAEF,MAAM,MAAM,kBAAkB,GAAG;IAChC,YAAY,EAAE,OAAO,CAAC,YAAY,EAAE,MAAM,GAAG,OAAO,GAAG,KAAK,GAAG,OAAO,GAAG,cAAc,CAAC,CAAC;IACzF,QAAQ,EACL,WAAW,GACX,eAAe,GACf,iBAAiB,GACjB,yBAAyB,GACzB,oBAAoB,GACpB,kBAAkB,CAAC;IACtB,KAAK,EAAE,MAAM,CAAC;CACd,GAAG,kBAAkB,CAAC;AAEvB,MAAM,MAAM,oBAAoB,GAAG;IAClC,YAAY,EAAE,OAAO,CAAC,YAAY,EAAE,QAAQ,CAAC,CAAC;IAC9C,QAAQ,EACL,eAAe,GACf,uBAAuB,GACvB,qBAAqB,GACrB,kBAAkB,GAClB,iCAAiC,GACjC,8BAA8B,CAAC;IAClC,KAAK,EAAE,MAAM,CAAC;CACd,GAAG,kBAAkB,CAAC;AAEvB,MAAM,MAAM,sBAAsB,GAAG;IACpC,YAAY,EAAE,OAAO,CAAC,YAAY,EAAE,UAAU,CAAC,CAAC;IAChD,QAAQ,EAAE,aAAa,GAAG,iBAAiB,CAAC;IAC5C,KAAK,EAAE,OAAO,CAAC;CACf,GAAG,kBAAkB,CAAC;AAEvB,MAAM,MAAM,oBAAoB,GAAG;IAClC,YAAY,EAAE,OAAO,CAAC,YAAY,EAAE,QAAQ,CAAC,CAAC;IAC9C,QAAQ,EAAE,SAAS,GAAG,aAAa,CAAC;IACpC,KAAK,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;CACrB,GAAG,kBAAkB,CAAC;AAEvB,MAAM,MAAM,yBAAyB,GAAG;IACvC,YAAY,EAAE,OAAO,CAAC,YAAY,EAAE,cAAc,CAAC,CAAC;IACpD,QAAQ,EAAE,eAAe,GAAG,uBAAuB,GAAG,mBAAmB,CAAC;IAC1E,KAAK,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;CACrB,GAAG,kBAAkB,CAAC;AAEvB,MAAM,MAAM,oBAAoB,GAAG;IAClC,YAAY,EAAE,OAAO,CAAC,YAAY,EAAE,QAAQ,CAAC,CAAC;IAC9C,QAAQ,EAAE,WAAW,GAAG,eAAe,CAAC;IACxC,KAAK,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;CACrB,GAAG,kBAAkB,CAAC;AAEvB;;;GAGG;AACH,MAAM,MAAM,kBAAkB,GAC3B,OAAO,GACP,UAAU,GACV,WAAW,GACX,cAAc,GACd,mBAAmB,GACnB,eAAe,GACf,oBAAoB,CAAC;AAExB;;GAEG;AACH,MAAM,MAAM,qBAAqB,GAAG,KAAK,GAAG,MAAM,GAAG,OAAO,GAAG,MAAM,CAAC;AAEtE;;;GAGG;AACH,MAAM,MAAM,cAAc,GAAG,YAAY,GAAG,UAAU,CAAC;AAEvD,MAAM,MAAM,4BAA4B,GAAG;IAAE,IAAI,EAAE,OAAO,CAAC;IAAC,KAAK,EAAE,MAAM,CAAA;CAAE,CAAC;AAE5E,MAAM,MAAM,+BAA+B,GAAG;IAC7C,IAAI,EAAE,UAAU,CAAC;IACjB,KAAK,EAAE,kBAAkB,CAAC;CAC1B,CAAC;AAEF,MAAM,MAAM,sCAAsC,GAAG;IACpD,IAAI,EAAE,mBAAmB,CAAC;IAC1B,KAAK,EAAE;QACN,SAAS,EAAE,MAAM,GAAG,MAAM,GAAG,MAAM,CAAC;QACpC,KAAK,CAAC,EAAE,MAAM,CAAC;QACf,IAAI,EAAE,qBAAqB,CAAC;KAC5B,CAAC;CACF,CAAC;AAEF;;;;;;GAMG;AACH,MAAM,MAAM,iCAAiC,GAAG;IAC/C,IAAI,EAAE,aAAa,CAAC;IACpB,KAAK,EAAE;QAAE,SAAS,EAAE,MAAM,CAAC;QAAC,OAAO,CAAC,EAAE,MAAM,CAAA;KAAE,GAAG;QAAE,SAAS,CAAC,EAAE,MAAM,CAAC;QAAC,OAAO,EAAE,MAAM,CAAA;KAAE,CAAC;CACzF,CAAC;AAEF;;;;;;;;;;GAUG;AACH,MAAM,MAAM,uBAAuB,GAChC,4BAA4B,GAC5B,+BAA+B,GAC/B,sCAAsC,GACtC,iCAAiC,CAAC;AAErC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAmEG;AACH,MAAM,MAAM,kBAAkB,GAC3B,CAAC;IACD,YAAY,EAAE,iBAAiB,CAAC;IAChC,QAAQ,EACL,SAAS,GACT,gBAAgB,GAChB,eAAe,GACf,sBAAsB,GACtB,qBAAqB,CAAC;IACzB,KAAK,EAAE,4BAA4B,GAAG,+BAA+B,CAAC;IACtE,cAAc,CAAC,EAAE,cAAc,CAAC;CAC/B,GAAG,kBAAkB,CAAC,GACvB,CAAC;IACD,YAAY,EAAE,iBAAiB,CAAC;IAChC,QAAQ,EAAE,qBAAqB,CAAC;IAChC,KAAK,EAAE,sCAAsC,CAAC;IAC9C,cAAc,CAAC,EAAE,cAAc,CAAC;CAC/B,GAAG,kBAAkB,CAAC,GACvB,CAAC;IACD,YAAY,EAAE,iBAAiB,CAAC;IAChC,QAAQ,EAAE,gBAAgB,CAAC;IAC3B,KAAK,EAAE,iCAAiC,CAAC;IACzC,cAAc,CAAC,EAAE,cAAc,CAAC;CAC/B,GAAG,kBAAkB,CAAC,CAAC;AAE3B,MAAM,MAAM,sBAAsB,GAAG;IACpC,YAAY,EAAE,OAAO,CAAC,YAAY,EAAE,UAAU,CAAC,CAAC;IAChD,QAAQ,EAAE,mBAAmB,GAAG,2BAA2B,CAAC;IAC5D,wFAAwF;IACxF,KAAK,EAAE;QAAE,IAAI,EAAE,OAAO,CAAC;QAAC,KAAK,EAAE,KAAK,CAAC,UAAU,CAAC,CAAA;KAAE,GAAG;QAAE,IAAI,EAAE,UAAU,CAAC;QAAC,KAAK,EAAE,WAAW,CAAA;KAAE,CAAC;CAC9F,GAAG,kBAAkB,CAAC;AAEvB;;;;GAIG;AACH,MAAM,MAAM,oBAAoB,GAAG;IAClC,YAAY,EAAE,OAAO,CAAC,YAAY,EAAE,QAAQ,GAAG,YAAY,GAAG,gBAAgB,CAAC,CAAC;IAChF,QAAQ,EAAE,iBAAiB,GAAG,yBAAyB,CAAC;IAExD,KAAK,EAAE,CAAC;QAAE,IAAI,EAAE,UAAU,CAAC;QAAC,KAAK,EAAE,IAAI,CAAA;KAAE,CAAC,CAAC;CAC3C,GAAG,kBAAkB,CAAC;AAEvB;;;;;;;;;;;;;;;GAeG;AACH,MAAM,MAAM,oBAAoB,GAC7B,kBAAkB,GAClB,oBAAoB,GACpB,sBAAsB,GACtB,oBAAoB,GACpB,yBAAyB,GACzB,oBAAoB,GACpB,kBAAkB,GAClB,sBAAsB,GACtB,oBAAoB,CAAC;AAExB,MAAM,MAAM,YAAY,GAAG,KAAK,CAAC,oBAAoB,GAAG,oBAAoB,CAAC,CAAC;AAE9E,MAAM,MAAM,oBAAoB,GAAG;IAClC,IAAI,EAAE,UAAU,CAAC;IACjB,QAAQ,EAAE,KAAK,GAAG,IAAI,CAAC;IACvB,OAAO,EAAE,YAAY,CAAC;CACtB,CAAC;AAEF;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAkDG;AACH,MAAM,MAAM,cAAc,GAAG;IAC5B,UAAU,EAAE,UAAU,CAAC;IACvB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd;;;;OAIG;IACH,IAAI,CAAC,EAAE,OAAO,CAAC,gBAAgB,EAAE;QAAE,IAAI,EAAE,aAAa,CAAA;KAAE,CAAC,CAAC;IAC1D,IAAI,EAAE,QAAQ,CAAC;IACf,+DAA+D;IAC/D,oBAAoB,EAAE,UAAU,CAAC;IACjC;;;;;;OAMG;IACH,eAAe,CAAC,EAAE,UAAU,CAAC;IAC7B;;;;OAIG;IACH,SAAS,CAAC,EAAE,OAAO,CAAC;IACpB,KAAK,CAAC,EAAE,KAAK,CAAC,sBAAsB,CAAC,CAAC;IACtC,kEAAkE;IAClE,OAAO,CAAC,EAAE,YAAY,CAAC;IACvB,iDAAiD;IACjD,YAAY,CAAC,EAAE,OAAO,CAAC;CACvB,CAAC;AAEF,MAAM,MAAM,eAAe,GAAG,cAAc,GAAG;IAC9C,IAAI,EAAE,OAAO,CAAC;IACd,UAAU,CAAC,EAAE,KAAK,CAAC,cAAc,CAAC,CAAC;IACnC,IAAI,CAAC,EAAE,OAAO,CAAC;IACf,OAAO,CAAC,EAAE,aAAa,CAAC;CACxB,CAAC;AAEF,MAAM,MAAM,eAAe,GAAG,cAAc,GAAG;IAC9C,IAAI,EAAE,OAAO,CAAC;IACd,UAAU,CAAC,EAAE,KAAK,CAAC,cAAc,CAAC,CAAC;IACnC,OAAO,CAAC,EAAE,aAAa,CAAC;IACxB,OAAO,CAAC,EAAE,KAAK,CAAC,WAAW,CAAC,CAAC;IAC7B,KAAK,CAAC,EAAE,WAAW,CAAC;IACpB,SAAS,CAAC,EAAE,eAAe,CAAC;IAC5B,WAAW,CAAC,EAAE,iBAAiB,CAAC;IAChC,IAAI,CAAC,EAAE,OAAO,CAAC;CACf,CAAC;AAEF,MAAM,MAAM,kBAAkB,GAAG,cAAc,GAAG;IACjD,IAAI,EAAE,UAAU,CAAC;IACjB,UAAU,CAAC,EAAE,KAAK,CAAC,cAAc,CAAC,CAAC;IACnC;;;;;;OAMG;IACH,UAAU,EAAE,UAAU,CAAC;IACvB,YAAY,CAAC,EAAE,OAAO,CAAC;CACvB,CAAC;AAEF,MAAM,MAAM,cAAc,GAAG,cAAc,GAAG;IAC7C,IAAI,EAAE,MAAM,CAAC;IACb,UAAU,CAAC,EAAE,KAAK,CAAC,cAAc,CAAC,CAAC;IACnC,OAAO,CAAC,EAAE,aAAa,CAAC;CACxB,CAAC;AAEF,MAAM,MAAM,iBAAiB,GAAG,cAAc,GAAG;IAChD,IAAI,EAAE,SAAS,CAAC;IAChB,UAAU,CAAC,EAAE,KAAK,CAAC,cAAc,CAAC,CAAC;IACnC,KAAK,CAAC,EAAE,WAAW,CAAC;IACpB,SAAS,CAAC,EAAE,eAAe,CAAC;IAC5B,WAAW,CAAC,EAAE,iBAAiB,CAAC;CAChC,CAAC;AAEF,MAAM,MAAM,cAAc,GAAG,cAAc,GAAG;IAC7C,IAAI,EAAE,MAAM,CAAC;IACb,UAAU,CAAC,EAAE,KAAK,CAAC,cAAc,CAAC,CAAC;IACnC,IAAI,CAAC,EAAE,OAAO,CAAC;IACf,gBAAgB,CAAC,EAAE,OAAO,CAAC;CAC3B,CAAC;AAEF,MAAM,MAAM,kBAAkB,GAAG,cAAc,GAAG;IACjD,IAAI,EAAE,UAAU,CAAC;IACjB,UAAU,CAAC,EAAE,KAAK,CAAC,cAAc,CAAC,CAAC;IACnC,eAAe,CAAC,EAAE,KAAK,CAAC,cAAc,CAAC,CAAC;IACxC;;;;;;OAMG;IACH,UAAU,EAAE,UAAU,CAAC;IACvB;;;;OAIG;IACH,aAAa,CAAC,EAAE,UAAU,CAAC;IAC3B,SAAS,CAAC,EAAE,OAAO,CAAC;CACpB,CAAC;AAEF,MAAM,MAAM,UAAU,GACnB,eAAe,GACf,eAAe,GACf,kBAAkB,GAClB,cAAc,GACd,iBAAiB,GACjB,cAAc,GACd,kBAAkB,CAAC"}

package/dist/oauth.d.ts

@@ -0,0 +1,11 @@
+/** OAuth 2.0 provider configuration. The secret value is stored with the app. */
+export type OAuthConfiguration = {
+    authorizationEndpoint: string;
+    tokenEndpoint: string;
+    clientId: string;
+    clientSecretEnv: string;
+    scope: string;
+    authorizationParams?: Record<string, string>;
+    accessTokenExpireMs?: number;
+};
+//# sourceMappingURL=oauth.d.ts.map

package/dist/oauth.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"oauth.d.ts","sourceRoot":"","sources":["../src/oauth.ts"],"names":[],"mappings":"AAAA,iFAAiF;AACjF,MAAM,MAAM,kBAAkB,GAAG;IAChC,qBAAqB,EAAE,MAAM,CAAC;IAC9B,aAAa,EAAE,MAAM,CAAC;IACtB,QAAQ,EAAE,MAAM,CAAC;IACjB,eAAe,EAAE,MAAM,CAAC;IACxB,KAAK,EAAE,MAAM,CAAC;IACd,mBAAmB,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IAC7C,mBAAmB,CAAC,EAAE,MAAM,CAAC;CAC7B,CAAC"}

package/dist/oauth.js

@@ -0,0 +1,26 @@
+function validateOAuthConfiguration(config) {
+  if (!config.clientId || !/^[A-Za-z_][A-Za-z0-9_]*$/.test(config.clientSecretEnv))
+    throw new Error("OAuth connections require a client ID and clientSecretEnv secret name.");
+  for (const endpoint of [config.authorizationEndpoint, config.tokenEndpoint]) {
+    const url = new URL(endpoint);
+    if (url.protocol !== "https:" || url.username || url.password || url.hash)
+      throw new Error("OAuth endpoints must be HTTPS URLs without credentials or fragments.");
+  }
+  if (config.accessTokenExpireMs !== void 0 && (!Number.isFinite(config.accessTokenExpireMs) || config.accessTokenExpireMs <= 0))
+    throw new Error("OAuth token expiry must be positive.");
+  if (Object.keys(config.authorizationParams ?? {}).some(
+    (key) => [
+      "state",
+      "redirect_uri",
+      "client_id",
+      "response_type",
+      "code_challenge",
+      "code_challenge_method",
+      "scope"
+    ].includes(key)
+  ))
+    throw new Error("OAuth authorization parameters cannot override protocol fields.");
+}
+export {
+  validateOAuthConfiguration
+};

package/dist/providers.generated.d.ts

@@ -26,92 +26,32 @@ export declare const connections: {
     outlook: typeof outlook;
     salesforce: typeof salesforce;
 };
-export type ConnectionProviders = {
-    calendar(key?: string): CalendarConnectionClient;
-    slack(key?: string): SlackConnectionClient;
-    googleDriveOauth(key?: string): GoogleDriveOauthConnectionClient;
-    discord(key?: string): DiscordConnectionClient;
-    cursor(key?: string): CursorConnectionClient;
-    box(key?: string): BoxConnectionClient;
-    confluence(key?: string): ConfluenceConnectionClient;
-    gmail(key?: string): GmailConnectionClient;
-    googleCalendar(key?: string): GoogleCalendarConnectionClient;
-    googleDrive(key?: string): GoogleDriveConnectionClient;
-    outlook(key?: string): OutlookConnectionClient;
-    salesforce(key?: string): SalesforceConnectionClient;
+export type ConnectionClients = {
+    calendar: CalendarConnectionClient;
+    slack: SlackConnectionClient;
+    googleDriveOauth: GoogleDriveOauthConnectionClient;
+    discord: DiscordConnectionClient;
+    cursor: CursorConnectionClient;
+    box: BoxConnectionClient;
+    confluence: ConfluenceConnectionClient;
+    gmail: GmailConnectionClient;
+    googleCalendar: GoogleCalendarConnectionClient;
+    googleDrive: GoogleDriveConnectionClient;
+    outlook: OutlookConnectionClient;
+    salesforce: SalesforceConnectionClient;
 };
-export declare function createConnectionProviders(invoker: (provider: string, key: string) => ConnectionActionInvoker): ConnectionProviders;
-declare function calendar(options?: {
-    key?: never;
-}): WorkflowConnection<"calendar", "calendar">;
-declare function calendar<const TKey extends string>(options: {
-    key: TKey;
-}): WorkflowConnection<"calendar", TKey>;
-declare function slack(options?: {
-    key?: never;
-}): WorkflowConnection<"slack", "slack">;
-declare function slack<const TKey extends string>(options: {
-    key: TKey;
-}): WorkflowConnection<"slack", TKey>;
-declare function googleDriveOauth(options?: {
-    key?: never;
-}): WorkflowConnection<"googleDriveOauth", "googleDriveOauth">;
-declare function googleDriveOauth<const TKey extends string>(options: {
-    key: TKey;
-}): WorkflowConnection<"googleDriveOauth", TKey>;
-declare function discord(options?: {
-    key?: never;
-}): WorkflowConnection<"discord", "discord">;
-declare function discord<const TKey extends string>(options: {
-    key: TKey;
-}): WorkflowConnection<"discord", TKey>;
-declare function cursor(options?: {
-    key?: never;
-}): WorkflowConnection<"cursor", "cursor">;
-declare function cursor<const TKey extends string>(options: {
-    key: TKey;
-}): WorkflowConnection<"cursor", TKey>;
-declare function box(options?: {
-    key?: never;
-}): WorkflowConnection<"box", "box">;
-declare function box<const TKey extends string>(options: {
-    key: TKey;
-}): WorkflowConnection<"box", TKey>;
-declare function confluence(options?: {
-    key?: never;
-}): WorkflowConnection<"confluence", "confluence">;
-declare function confluence<const TKey extends string>(options: {
-    key: TKey;
-}): WorkflowConnection<"confluence", TKey>;
-declare function gmail(options?: {
-    key?: never;
-}): WorkflowConnection<"gmail", "gmail">;
-declare function gmail<const TKey extends string>(options: {
-    key: TKey;
-}): WorkflowConnection<"gmail", TKey>;
-declare function googleCalendar(options?: {
-    key?: never;
-}): WorkflowConnection<"googleCalendar", "googleCalendar">;
-declare function googleCalendar<const TKey extends string>(options: {
-    key: TKey;
-}): WorkflowConnection<"googleCalendar", TKey>;
-declare function googleDrive(options?: {
-    key?: never;
-}): WorkflowConnection<"googleDrive", "googleDrive">;
-declare function googleDrive<const TKey extends string>(options: {
-    key: TKey;
-}): WorkflowConnection<"googleDrive", TKey>;
-declare function outlook(options?: {
-    key?: never;
-}): WorkflowConnection<"outlook", "outlook">;
-declare function outlook<const TKey extends string>(options: {
-    key: TKey;
-}): WorkflowConnection<"outlook", TKey>;
-declare function salesforce(options?: {
-    key?: never;
-}): WorkflowConnection<"salesforce", "salesforce">;
-declare function salesforce<const TKey extends string>(options: {
-    key: TKey;
-}): WorkflowConnection<"salesforce", TKey>;
+export declare function createConnectionClient(provider: string, invoker: ConnectionActionInvoker): ConnectionClients[keyof ConnectionClients];
+declare function calendar(): WorkflowConnection<"calendar">;
+declare function slack(): WorkflowConnection<"slack">;
+declare function googleDriveOauth(): WorkflowConnection<"googleDriveOauth">;
+declare function discord(): WorkflowConnection<"discord">;
+declare function cursor(): WorkflowConnection<"cursor">;
+declare function box(): WorkflowConnection<"box">;
+declare function confluence(): WorkflowConnection<"confluence">;
+declare function gmail(): WorkflowConnection<"gmail">;
+declare function googleCalendar(): WorkflowConnection<"googleCalendar">;
+declare function googleDrive(): WorkflowConnection<"googleDrive">;
+declare function outlook(): WorkflowConnection<"outlook">;
+declare function salesforce(): WorkflowConnection<"salesforce">;
 export {};
 //# sourceMappingURL=providers.generated.d.ts.map