@webstudio-is/sdk 0.0.0-021f2d4

package/lib/types/core-templates.d.ts

@@ -0,0 +1,6 @@
+import { type TemplateMeta } from "@webstudio-is/template";
+export declare const coreTemplates: {
+    "ws:collection": TemplateMeta;
+    "ws:descendant": TemplateMeta;
+    "ws:block": TemplateMeta;
+};

package/lib/types/expression.d.ts

@@ -0,0 +1,58 @@
+import { type Identifier } from "acorn";
+import type { DataSources } from "./schema/data-sources";
+import type { Scope } from "./scope";
+export type Diagnostic = {
+    from: number;
+    to: number;
+    severity: "error" | "hint" | "info" | "warning";
+    message: string;
+};
+export declare const lintExpression: ({ expression, availableVariables, allowAssignment, }: {
+    expression: string;
+    availableVariables?: Set<Identifier["name"]>;
+    allowAssignment?: boolean;
+}) => Diagnostic[];
+/**
+ * check whether provided expression is a literal value
+ * like "", 0 or { param: "value" }
+ * which does not depends on any variable
+ */
+export declare const isLiteralExpression: (expression: string) => boolean;
+export declare const getExpressionIdentifiers: (expression: string) => Set<string>;
+/**
+ * transpile expression into executable one
+ *
+ * add optional chaining operator to every member expression
+ * to access any field without runtime errors
+ *
+ * replace variable names if necessary
+ */
+export declare const transpileExpression: ({ expression, executable, replaceVariable, }: {
+    expression: string;
+    executable?: boolean;
+    replaceVariable?: (identifier: string, assignee: boolean) => string | undefined | void;
+}) => string;
+/**
+ * parse object expression into key value map
+ * where each value is expression
+ */
+export declare const parseObjectExpression: (expression: string) => Map<string, string>;
+/**
+ * generate key value map into object expression
+ * after updating individual value expressions
+ */
+export declare const generateObjectExpression: (map: Map<string, string>) => string;
+export declare const encodeDataSourceVariable: (id: string) => string;
+export { encodeDataSourceVariable as encodeDataVariableId };
+export declare const decodeDataSourceVariable: (name: string) => string | undefined;
+export { decodeDataSourceVariable as decodeDataVariableId };
+export declare const generateExpression: ({ expression, dataSources, usedDataSources, scope, }: {
+    expression: string;
+    dataSources: DataSources;
+    usedDataSources: DataSources;
+    scope: Scope;
+}) => string;
+/**
+ * edge case utility for "statoc" expression without variables
+ */
+export declare const executeExpression: (expression: undefined | string) => any;

package/lib/types/expression.test.d.ts

@@ -0,0 +1 @@
+export {};

package/lib/types/form-fields.d.ts

@@ -0,0 +1,8 @@
+/**
+ * Used to identify form inside server handler
+ */
+export declare const formIdFieldName = "ws--form-id";
+/**
+ * Used for simlpe protection against non js bots
+ */
+export declare const formBotFieldName = "ws--form-bot";

package/lib/types/index.d.ts

@@ -0,0 +1,23 @@
+export * from "./schema/assets";
+export * from "./schema/pages";
+export * from "./schema/instances";
+export * from "./schema/data-sources";
+export * from "./schema/resources";
+export * from "./schema/props";
+export * from "./schema/breakpoints";
+export * from "./schema/style-sources";
+export * from "./schema/style-source-selections";
+export * from "./schema/styles";
+export * from "./schema/deployment";
+export * from "./schema/webstudio";
+export * from "./schema/prop-meta";
+export * from "./schema/embed-template";
+export * from "./schema/component-meta";
+export * from "./core-metas";
+export * from "./instances-utils";
+export * from "./page-utils";
+export * from "./scope";
+export * from "./expression";
+export * from "./resources-generator";
+export * from "./page-meta-generator";
+export * from "./url-pattern";

package/lib/types/instances-utils.d.ts

@@ -0,0 +1,5 @@
+import type { Instance, Instances } from "./schema/instances";
+export declare const ROOT_INSTANCE_ID = ":root";
+export declare const findTreeInstanceIds: (instances: Instances, rootInstanceId: Instance["id"]) => Set<string>;
+export declare const findTreeInstanceIdsExcludingSlotDescendants: (instances: Instances, rootInstanceId: Instance["id"]) => Set<string>;
+export declare const parseComponentName: (componentName: string) => readonly [string | undefined, string];

package/lib/types/instances-utils.test.d.ts

@@ -0,0 +1 @@
+export {};

package/lib/types/page-meta-generator.d.ts

@@ -0,0 +1,24 @@
+import type { Asset, Assets } from "./schema/assets";
+import type { DataSources } from "./schema/data-sources";
+import type { Page } from "./schema/pages";
+import { type Scope } from "./scope";
+export type PageMeta = {
+    title: string;
+    description?: string;
+    excludePageFromSearch?: boolean;
+    language?: string;
+    socialImageAssetName?: Asset["name"];
+    socialImageUrl?: string;
+    status?: number;
+    redirect?: string;
+    custom: Array<{
+        property: string;
+        content: string;
+    }>;
+};
+export declare const generatePageMeta: ({ globalScope, page, dataSources, assets, }: {
+    globalScope: Scope;
+    page: Page;
+    dataSources: DataSources;
+    assets: Assets;
+}) => string;

package/lib/types/page-meta-generator.test.d.ts

@@ -0,0 +1 @@
+export {};

package/lib/types/page-utils.d.ts

@@ -0,0 +1,24 @@
+import type { Folder, Page, Pages } from "./schema/pages";
+export declare const ROOT_FOLDER_ID = "root";
+/**
+ * Returns true if folder is the root folder.
+ */
+export declare const isRootFolder: ({ id }: {
+    id: Folder["id"];
+}) => boolean;
+/**
+ * Find a page by id or path.
+ */
+export declare const findPageByIdOrPath: (idOrPath: string, pages: Pages) => Page | undefined;
+/**
+ * Find a folder that has has that id in the children.
+ */
+export declare const findParentFolderByChildId: (id: Folder["id"] | Page["id"], folders: Array<Folder>) => Folder | undefined;
+/**
+ * Get a path from all folder slugs from root to the current folder or page.
+ */
+export declare const getPagePath: (id: Folder["id"] | Page["id"], pages: Pages) => string;
+export declare const getStaticSiteMapXml: (pages: Pages, updatedAt: string) => {
+    path: string;
+    lastModified: string;
+}[];

package/lib/types/page-utils.test.d.ts

@@ -0,0 +1 @@
+export {};

package/lib/types/resource-loader.d.ts

@@ -0,0 +1,30 @@
+import type { ResourceRequest } from "./schema/resources";
+/**
+ * Prevents fetch cycles by prefixing local resources.
+ */
+export declare const isLocalResource: (pathname: string, resourceName?: string) => boolean;
+export declare const sitemapResourceUrl = "/$resources/sitemap.xml";
+export declare const loadResource: (customFetch: typeof fetch, resourceRequest: ResourceRequest) => Promise<{
+    ok: boolean;
+    data: string;
+    status: number;
+    statusText: string;
+} | {
+    ok: boolean;
+    data: undefined;
+    status: number;
+    statusText: string;
+}>;
+export declare const loadResources: (customFetch: typeof fetch, requests: Map<string, ResourceRequest>) => Promise<{
+    [k: string]: {
+        ok: boolean;
+        data: string;
+        status: number;
+        statusText: string;
+    } | {
+        ok: boolean;
+        data: undefined;
+        status: number;
+        statusText: string;
+    };
+}>;

package/lib/types/resource-loader.test.d.ts

@@ -0,0 +1 @@
+export {};

package/lib/types/resources-generator.d.ts

@@ -0,0 +1,22 @@
+import type { DataSources } from "./schema/data-sources";
+import type { Page } from "./schema/pages";
+import type { Resources } from "./schema/resources";
+import type { Props } from "./schema/props";
+import type { Instances } from "./schema/instances";
+import type { Scope } from "./scope";
+export declare const generateResources: ({ scope, page, dataSources, props, resources, }: {
+    scope: Scope;
+    page: Page;
+    dataSources: DataSources;
+    props: Props;
+    resources: Resources;
+}) => string;
+/**
+ * migrate webhook forms to resource action
+ * @todo move to client migrations eventually
+ */
+export declare const replaceFormActionsWithResources: ({ props, instances, resources, }: {
+    props: Props;
+    instances: Instances;
+    resources: Resources;
+}) => void;

package/lib/types/resources-generator.test.d.ts

@@ -0,0 +1 @@
+export {};

package/lib/types/runtime.d.ts

@@ -0,0 +1,3 @@
+export * from "./resource-loader";
+export * from "./to-string";
+export * from "./form-fields";