@softr/sdk 0.0.10 → 0.0.12

package/dist/types-n-Sir_Y2.d.ts

@@ -0,0 +1,482 @@
+//#region src/core/query.d.ts
+
+type LogicalOperator = "AND" | "OR";
+type FilterOperator = "IS" | "IS_NOT" | "EQUAL" | "NOT_EQUAL" | "IS_EMPTY" | "IS_NOT_EMPTY" | "IS_ONE_OF" | "IS_NONE_OF" | "HAS_ALL_OF" | "HAS_ONE_OF" | "HAS_NONE_OF" | "CONTAINS" | "INLINE_CONTAINS" | "GT" | "LT" | "GTE" | "LTE" | "BETWEEN" | "IS_NOT_BETWEEN" | "DOES_NOT_CONTAINS" | "STARTS_WITH" | "ENDS_WITH";
+type ConditionFieldType = "TEXT" | "BOOLEAN" | "NUMERIC" | "ARRAY" | "DATE";
+interface Filter {
+  subject: string;
+  operator: FilterOperator;
+  value?: unknown;
+  type: ConditionFieldType;
+}
+type ConstructableFilter = Filter & {
+  [INTERNAL_KIND]: "FILTER";
+};
+type ConstructableFilterGroup = {
+  logicalOperator: LogicalOperator;
+  filters: Array<ConstructableFilter | ConstructableFilterGroup>;
+  [INTERNAL_KIND]: "LOGICAL_GROUP";
+};
+interface SortingOptionItem {
+  sortingField: string;
+  sortType: "ASC" | "DESC";
+}
+type ConstructableOrderBy = SortingOptionItem & {
+  [INTERNAL_KIND]: "ORDER_BY";
+};
+type AnyConstructable = ConstructableFilter | ConstructableFilterGroup;
+declare const INTERNAL_KIND: unique symbol;
+/**
+ * Query builder for filter queries. This exist to alleviate the (LLM?) mental overhead. API filter schema is a bit
+ * verbose and confusing, even when dealing with very basic queries. So to fall into the pit of success, aim here
+ * is to simplify filtering as much as possible.
+ *
+ * @example
+ * single filter
+ * ```tsx
+ * const query = q.text("title").contains("hello");
+ *
+ * const json = buildFilterCriteria(query);
+ * // result
+ * {
+ *   "filterCriteria": {
+ *     "filterConditionGroup": {
+ *       "logicalOperator": "AND"
+ *       "filterGroups": [{
+ *         "logicalOperator": "AND",
+ *         "filters": [{
+ *           "subject": "title",
+ *           "type": "TEXT",
+ *           "operator": "CONTAINS",
+ *           "value": "hello"
+ *         }],
+ *       }]
+ *     }
+ *   }
+ *  }
+ *
+ * ```
+ *
+ * @example
+ * combining multiple filters
+ * ```tsx
+ * const query = q.and(
+ *   q.text("title").contains("hello"),
+ *   q.number("views").is(100),
+ *   q.or(
+ *     q.text("author").is("John"),
+ *     q.boolean("isPublished").is(true)
+ *   )
+ * );
+ * ```
+ */
+declare const q: {
+  select<T extends Record<string, string>>(mapping: T): T;
+  and(...filters: AnyConstructable[]): ConstructableFilterGroup;
+  or(...filters: AnyConstructable[]): ConstructableFilterGroup;
+  text(subject: string): {
+    is(value: string): {
+      operator: "IS";
+      value: string;
+      subject: string;
+      type: "TEXT";
+      [INTERNAL_KIND]: "FILTER";
+    };
+    isNot(value: string): {
+      operator: "IS_NOT";
+      value: string;
+      subject: string;
+      type: "TEXT";
+      [INTERNAL_KIND]: "FILTER";
+    };
+    contains(value: string): {
+      operator: "CONTAINS";
+      value: string;
+      subject: string;
+      type: "TEXT";
+      [INTERNAL_KIND]: "FILTER";
+    };
+    isOneOf(value: string[]): {
+      operator: "IS_ONE_OF";
+      value: string[];
+      subject: string;
+      type: "TEXT";
+      [INTERNAL_KIND]: "FILTER";
+    };
+    isNoneOf(value: string[]): {
+      operator: "IS_NONE_OF";
+      value: string[];
+      subject: string;
+      type: "TEXT";
+      [INTERNAL_KIND]: "FILTER";
+    };
+    startsWith(value: string): {
+      operator: "STARTS_WITH";
+      value: string;
+      subject: string;
+      type: "TEXT";
+      [INTERNAL_KIND]: "FILTER";
+    };
+    endsWith(value: string): {
+      operator: "ENDS_WITH";
+      value: string;
+      subject: string;
+      type: "TEXT";
+      [INTERNAL_KIND]: "FILTER";
+    };
+    hasAllOf(value: string[]): {
+      operator: "HAS_ALL_OF";
+      value: string[];
+      subject: string;
+      type: "TEXT";
+      [INTERNAL_KIND]: "FILTER";
+    };
+    isEmpty(): {
+      operator: "IS_EMPTY";
+      subject: string;
+      type: "TEXT";
+      [INTERNAL_KIND]: "FILTER";
+    };
+    isNotEmpty(): {
+      operator: "IS_NOT_EMPTY";
+      subject: string;
+      type: "TEXT";
+      [INTERNAL_KIND]: "FILTER";
+    };
+  };
+  boolean(subject: string): {
+    is(value: boolean): {
+      operator: "IS";
+      value: boolean;
+      subject: string;
+      type: "BOOLEAN";
+      [INTERNAL_KIND]: "FILTER";
+    };
+    isNot(value: boolean): {
+      operator: "IS_NOT";
+      value: boolean;
+      subject: string;
+      type: "BOOLEAN";
+      [INTERNAL_KIND]: "FILTER";
+    };
+    isEmpty(): {
+      operator: "IS_EMPTY";
+      subject: string;
+      type: "BOOLEAN";
+      [INTERNAL_KIND]: "FILTER";
+    };
+    isNotEmpty(): {
+      operator: "IS_NOT_EMPTY";
+      subject: string;
+      type: "BOOLEAN";
+      [INTERNAL_KIND]: "FILTER";
+    };
+  };
+  number(subject: string): {
+    is(value: number): {
+      operator: "IS";
+      value: string;
+      subject: string;
+      type: "NUMERIC";
+      [INTERNAL_KIND]: "FILTER";
+    };
+    isNot(value: number): {
+      operator: "IS_NOT";
+      value: string;
+      subject: string;
+      type: "NUMERIC";
+      [INTERNAL_KIND]: "FILTER";
+    };
+    gt(value: number): {
+      operator: "GT";
+      value: string;
+      subject: string;
+      type: "NUMERIC";
+      [INTERNAL_KIND]: "FILTER";
+    };
+    gte(value: number): {
+      operator: "GTE";
+      value: string;
+      subject: string;
+      type: "NUMERIC";
+      [INTERNAL_KIND]: "FILTER";
+    };
+    lt(value: number): {
+      operator: "LT";
+      value: string;
+      subject: string;
+      type: "NUMERIC";
+      [INTERNAL_KIND]: "FILTER";
+    };
+    lte(value: number): {
+      operator: "LTE";
+      value: string;
+      subject: string;
+      type: "NUMERIC";
+      [INTERNAL_KIND]: "FILTER";
+    };
+    between(start: number, end: number): {
+      operator: "BETWEEN";
+      value: string[];
+      subject: string;
+      type: "NUMERIC";
+      [INTERNAL_KIND]: "FILTER";
+    };
+    isEmpty(): {
+      operator: "IS_EMPTY";
+      subject: string;
+      type: "NUMERIC";
+      [INTERNAL_KIND]: "FILTER";
+    };
+    isNotEmpty(): {
+      operator: "IS_NOT_EMPTY";
+      subject: string;
+      type: "NUMERIC";
+      [INTERNAL_KIND]: "FILTER";
+    };
+  };
+  array(subject: string): {
+    is(value: string[]): {
+      operator: "IS";
+      value: string[];
+      subject: string;
+      type: "ARRAY";
+      [INTERNAL_KIND]: "FILTER";
+    };
+    isOneOf(value: string[]): {
+      operator: "IS_ONE_OF";
+      value: string[];
+      subject: string;
+      type: "ARRAY";
+      [INTERNAL_KIND]: "FILTER";
+    };
+    isNoneOf(value: string[]): {
+      operator: "IS_NONE_OF";
+      value: string[];
+      subject: string;
+      type: "ARRAY";
+      [INTERNAL_KIND]: "FILTER";
+    };
+    hasAllOf(value: string[]): {
+      operator: "HAS_ALL_OF";
+      value: string[];
+      subject: string;
+      type: "ARRAY";
+      [INTERNAL_KIND]: "FILTER";
+    };
+    isEmpty(): {
+      operator: "IS_EMPTY";
+      subject: string;
+      type: "ARRAY";
+      [INTERNAL_KIND]: "FILTER";
+    };
+    isNotEmpty(): {
+      operator: "IS_NOT_EMPTY";
+      subject: string;
+      type: "ARRAY";
+      [INTERNAL_KIND]: "FILTER";
+    };
+  };
+  date(subject: string): {
+    is(value: string): {
+      operator: "IS";
+      value: string;
+      subject: string;
+      type: "DATE";
+      [INTERNAL_KIND]: "FILTER";
+    };
+    isNot(value: string): {
+      operator: "IS_NOT";
+      value: string;
+      subject: string;
+      type: "DATE";
+      [INTERNAL_KIND]: "FILTER";
+    };
+    gt(value: string): {
+      operator: "GT";
+      value: string;
+      subject: string;
+      type: "DATE";
+      [INTERNAL_KIND]: "FILTER";
+    };
+    gte(value: string): {
+      operator: "GTE";
+      value: string;
+      subject: string;
+      type: "DATE";
+      [INTERNAL_KIND]: "FILTER";
+    };
+    lt(value: string): {
+      operator: "LT";
+      value: string;
+      subject: string;
+      type: "DATE";
+      [INTERNAL_KIND]: "FILTER";
+    };
+    lte(value: string): {
+      operator: "LTE";
+      value: string;
+      subject: string;
+      type: "DATE";
+      [INTERNAL_KIND]: "FILTER";
+    };
+    between(start: string, end: string): {
+      operator: "BETWEEN";
+      value: string[];
+      subject: string;
+      type: "DATE";
+      [INTERNAL_KIND]: "FILTER";
+    };
+    isNotBetween(start: string, end: string): {
+      operator: "IS_NOT_BETWEEN";
+      value: string[];
+      subject: string;
+      type: "DATE";
+      [INTERNAL_KIND]: "FILTER";
+    };
+    isEmpty(): {
+      operator: "IS_EMPTY";
+      subject: string;
+      type: "DATE";
+      [INTERNAL_KIND]: "FILTER";
+    };
+    isNotEmpty(): {
+      operator: "IS_NOT_EMPTY";
+      subject: string;
+      type: "DATE";
+      [INTERNAL_KIND]: "FILTER";
+    };
+  };
+  asc(subject: string): ConstructableOrderBy;
+  desc(subject: string): ConstructableOrderBy;
+};
+//#endregion
+//#region src/auth/user.d.ts
+/**
+ * Declare this interface in your app to narrow every group id the SDK takes and
+ * returns. Without a declaration, a group id is a plain `string`.
+ *
+ * @example
+ * declare module "@softr/sdk" {
+ *   interface SoftrUserGroups {
+ *     ids:
+ *       | "b1f2c3d4-5e6f-4a7b-8c9d-0e1f2a3b4c5d"
+ *       | "f9e8d7c6-5b4a-4938-8271-605f4e3d2c1b"
+ *   }
+ * }
+ */
+interface SoftrUserGroups {}
+/** A Softr user group id, narrowed to your own ids if you declare {@link SoftrUserGroups}. */
+type SoftrUserGroupId = SoftrUserGroups extends {
+  ids: infer Id extends string;
+} ? Id : string;
+/** The signed-in visitor. */
+type User = {
+  id: string;
+  email: string;
+  name: string;
+  userGroupIds: Array<SoftrUserGroupId>;
+};
+//#endregion
+//#region src/types.d.ts
+interface SoftrUser {
+  id: string;
+  email: string;
+  name: string;
+  userGroupIds: Array<SoftrUserGroupId>;
+}
+interface DatasourcePermissions {
+  read: boolean;
+  create: boolean;
+  update: boolean;
+  delete: boolean;
+}
+interface SoftrPermissions {
+  datasources: Record<string, DatasourcePermissions>;
+  workflows: Record<string, boolean>;
+}
+interface SoftrMe {
+  user: SoftrUser | null;
+  permissions: SoftrPermissions;
+}
+type GetByIdOptions = {
+  id: string;
+  where?: never;
+  timeZone?: string;
+};
+type GetByWhereOptions = {
+  id?: never;
+  where: AnyConstructable;
+  timeZone?: string;
+};
+type GetOptions = GetByIdOptions | GetByWhereOptions;
+interface ListOptions {
+  /**
+   * Maps human-readable aliases to Softr field IDs.
+   * When provided, returned fields are keyed by alias instead of raw field ID.
+   */
+  select?: Record<string, string>;
+  where?: AnyConstructable;
+  orderBy?: ConstructableOrderBy | ConstructableOrderBy[];
+  /**
+   * Number of records to return per page. Defaults to 20, max 100.
+   */
+  limit?: number;
+  /**
+   * Offset to start from. Pass the `nextOffset` from a previous result to paginate.
+   * Omit or pass `null` to start from the beginning.
+   */
+  offset?: number | null;
+  /** Override the timezone for this request. */
+  timeZone?: string;
+}
+interface ListResult<T = SoftrRecord> {
+  records: T[];
+  total: number;
+  /** Offset to pass as `offset` in the next call, or `null` when there are no more pages. */
+  nextOffset: number | null;
+}
+interface SoftrRecord {
+  id: string;
+  fields: Record<string, unknown>;
+}
+type AggregationFunction = 'SUM' | 'AVG' | 'MAX' | 'MIN' | 'COUNT' | 'DISTINCT';
+interface MetricOptions {
+  select?: Record<string, string>;
+  where?: AnyConstructable;
+  aggregation: AggregationFunction;
+  /** Field alias (resolved via select) or raw field ID. Not required for COUNT. */
+  field?: string;
+  /** Override the timezone for this request. */
+  timeZone?: string;
+}
+interface MetricResult {
+  value: number | null;
+  executionTimestamp: Date;
+}
+interface ChartDataOptions {
+  select?: Record<string, string>;
+  where?: AnyConstructable;
+  /** Field alias (resolved via select) or raw field ID. */
+  groupBy: string | string[];
+  metrics: Record<string, {
+    field?: string;
+    aggregation: AggregationFunction;
+  }>;
+  orderBy?: ConstructableOrderBy;
+  /** Override the timezone for this request. */
+  timeZone?: string;
+}
+interface ChartDataResult {
+  data: Record<string, unknown>[];
+  executionTimestamp: Date;
+}
+interface CreateOptions {
+  fields: Record<string, unknown>;
+}
+interface UpdateOptions {
+  id: string;
+  fields: Record<string, unknown>;
+}
+//#endregion
+export { SoftrUserGroups as _, DatasourcePermissions as a, ListResult as c, SoftrMe as d, SoftrPermissions as f, SoftrUserGroupId as g, UpdateOptions as h, CreateOptions as i, MetricOptions as l, SoftrUser as m, ChartDataOptions as n, GetOptions as o, SoftrRecord as p, ChartDataResult as r, ListOptions as s, AggregationFunction as t, MetricResult as u, User as v, q as y };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@softr/sdk",
-  "version": "0.0.10",
+  "version": "0.0.12",
   "type": "module",
   "exports": {
     ".": { "types": "./dist/index.d.ts", "import": "./dist/index.js" },