@proveanything/smartlinks 2.0.34 → 2.0.35

package/dist/http.d.ts

@@ -31,6 +31,10 @@ export declare function isProxyEnabled(): boolean;
 export declare function getAppContext(): string | undefined;
 /** Set (or clear) the current app context — the appId used to scope SL.functions calls. */
 export declare function setAppContext(id: string | undefined): void;
+/** The release channel explicitly set for this app build (initializeApi({ appChannel }) / setAppChannel). */
+export declare function getAppChannel(): string | undefined;
+/** Set (or clear) the release channel SL.functions calls target. */
+export declare function setAppChannel(channel: string | undefined): void;
 export declare function initializeApi(options: {
     baseURL: string;
     apiKey?: string;
@@ -52,6 +56,13 @@ export declare function initializeApi(options: {
      * Preserved across re-initialization when not supplied.
      */
     appId?: string;
+    /**
+     * The release channel this build is running as ('dev' | 'alpha' | 'beta' | 'stable'). Normally
+     * left unset — hosts that run a non-production build (Forge preview of a Test build) pass
+     * `appChannel` in the app's context and the SDK picks it up. Preserved across re-initialization
+     * when not supplied.
+     */
+    appChannel?: string;
     /**
      * Declares that a bearer token will arrive asynchronously (e.g. handed by the host over
      * postMessage in a dev/direct embed). Until setBearerToken() is called, outgoing requests wait

package/dist/http.js

@@ -52,6 +52,14 @@ let grantToken = undefined;
  * app-scoped when this is set. Explicit `appId` on a call always overrides it.
  */
 let appContextId = undefined;
+/**
+ * The release CHANNEL this app build is running as ('dev' | 'alpha' | 'beta' | 'stable'), when the
+ * host says so — e.g. Forge's preview of a Test build. SL.functions then calls that channel's
+ * release (/app/:appId/<channel>/functions/:name). Unset = production behaviour: the server runs the
+ * release the collection has installed. Set via initializeApi({ appChannel }) / setAppChannel(), or
+ * picked up from the host's `appChannel` context param (see functions.ts).
+ */
+let appChannelId = undefined;
 /**
  * Auth-ready gate. When an app declares (initializeApi({ awaitAuth: true })) that its bearer token
  * will arrive ASYNCHRONOUSLY — e.g. a dev app embedded in the console that receives its token over
@@ -318,6 +326,14 @@ export function getAppContext() {
 export function setAppContext(id) {
     appContextId = id;
 }
+/** The release channel explicitly set for this app build (initializeApi({ appChannel }) / setAppChannel). */
+export function getAppChannel() {
+    return appChannelId;
+}
+/** Set (or clear) the release channel SL.functions calls target. */
+export function setAppChannel(channel) {
+    appChannelId = channel;
+}
 function maskSensitive(value) {
     if (!value)
         return value;
@@ -471,6 +487,8 @@ export function initializeApi(options) {
     // Preserve the app context across re-inits that omit it (mirrors platform/token handling).
     if (options.appId !== undefined)
         appContextId = options.appId;
+    if (options.appChannel !== undefined)
+        appChannelId = options.appChannel;
     // Enable token persistence before restoring the token.
     if (options.persistToken !== undefined)
         tokenPersistenceEnabled = options.persistToken;

package/dist/index.d.ts

@@ -1,4 +1,4 @@
-export { initializeApi, isInitialized, hasAuthCredentials, configureSdkCache, invalidateCache, getHttpCacheDiagnostics, resetHttpCacheDiagnostics, request, post, put, patch, del, sendCustomProxyMessage, getApiHeaders, getBaseURL, isProxyEnabled, setBearerToken, getBearerToken, setGrantToken, getGrantToken, getAppContext, setAppContext } from "./http.js";
+export { initializeApi, isInitialized, hasAuthCredentials, configureSdkCache, invalidateCache, getHttpCacheDiagnostics, resetHttpCacheDiagnostics, request, post, put, patch, del, sendCustomProxyMessage, getApiHeaders, getBaseURL, isProxyEnabled, setBearerToken, getBearerToken, setGrantToken, getGrantToken, getAppContext, setAppContext, getAppChannel, setAppChannel } from "./http.js";
 export * from "./api/index.js";
 export * from "./types/index.js";
 export { iframe } from "./iframe.js";

package/dist/index.js

@@ -1,6 +1,6 @@
 // src/index.ts
 // Top-level entrypoint of the npm package. Re-export initializeApi + all namespaces.
-export { initializeApi, isInitialized, hasAuthCredentials, configureSdkCache, invalidateCache, getHttpCacheDiagnostics, resetHttpCacheDiagnostics, request, post, put, patch, del, sendCustomProxyMessage, getApiHeaders, getBaseURL, isProxyEnabled, setBearerToken, getBearerToken, setGrantToken, getGrantToken, getAppContext, setAppContext } from "./http.js";
+export { initializeApi, isInitialized, hasAuthCredentials, configureSdkCache, invalidateCache, getHttpCacheDiagnostics, resetHttpCacheDiagnostics, request, post, put, patch, del, sendCustomProxyMessage, getApiHeaders, getBaseURL, isProxyEnabled, setBearerToken, getBearerToken, setGrantToken, getGrantToken, getAppContext, setAppContext, getAppChannel, setAppChannel } from "./http.js";
 export * from "./api/index.js";
 export * from "./types/index.js";
 // Iframe namespace

package/dist/openapi.yaml

@@ -74,6 +74,8 @@ tags:
     description: Product facet querying and aggregation.
   - name: form
     description: Form definitions and submissions.
+  - name: functions
+    description: functions API
   - name: integrations
     description: Third-party integration flows and imports.
   - name: interactions
@@ -10022,6 +10024,26 @@ paths:
           description: Unauthorized
         404:
           description: Not found
+  /functions:
+    get:
+      tags:
+        - functions
+      summary: List the public functions available for a collection (discovery).
+      operationId: functions_list
+      security: []
+      responses:
+        200:
+          description: Success
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/FunctionListResponse"
+        400:
+          description: Bad request
+        401:
+          description: Unauthorized
+        404:
+          description: Not found
   /platform/location:
     post:
       tags:
@@ -17223,6 +17245,68 @@ components:
           additionalProperties: true
       required:
         - url
+    PdfBox:
+      type: object
+      properties:
+        x:
+          type: object
+          additionalProperties: true
+      required:
+        - x
+    PdfEditArgs:
+      type: object
+      properties:
+        url:
+          type: string
+        replaceText:
+          type: array
+          items:
+            type: object
+            additionalProperties: true
+        addText:
+          type: array
+          items:
+            type: object
+            additionalProperties: true
+        addImages:
+          type: array
+          items:
+            type: object
+            additionalProperties: true
+        preserveColour:
+          type: boolean
+      required:
+        - url
+    PdfPreflightArgs:
+      type: object
+      properties:
+        url:
+          type: object
+          additionalProperties: true
+      required:
+        - url
+    PdfPrintReadyArgs:
+      type: object
+      properties:
+        url:
+          type: string
+        profile:
+          $ref: "#/components/schemas/PdfXProfile"
+        outputIntent:
+          type: string
+        convertToCmyk:
+          type: boolean
+        embedFonts:
+          type: boolean
+        bleed:
+          type: object
+          additionalProperties: true
+        flattenTransparency:
+          type: boolean
+        minDpi:
+          type: number
+      required:
+        - url
     HttpRequestArgs:
       type: object
       properties:
@@ -17290,6 +17374,12 @@ components:
           $ref: "#/components/schemas/PdfDecodeBarcodesArgs"
         pdf.inspectGraphics:
           $ref: "#/components/schemas/PdfInspectGraphicsArgs"
+        pdf.edit:
+          $ref: "#/components/schemas/PdfEditArgs"
+        pdf.preflight:
+          $ref: "#/components/schemas/PdfPreflightArgs"
+        pdf.printReady:
+          $ref: "#/components/schemas/PdfPrintReadyArgs"
         http.request:
           $ref: "#/components/schemas/HttpRequestArgs"
         translate:
@@ -17316,6 +17406,9 @@ components:
         - pdf.extract
         - pdf.decodeBarcodes
         - pdf.inspectGraphics
+        - pdf.edit
+        - pdf.preflight
+        - pdf.printReady
         - http.request
         - translate
     WebSearchResultItem:
@@ -17545,6 +17638,139 @@ components:
           additionalProperties: true
       required:
         - url
+    PdfEditItemResult:
+      type: object
+      properties:
+        id:
+          type: string
+        status:
+          type: string
+          enum:
+            - done
+            - failed
+        note:
+          type: string
+        verified:
+          type: boolean
+        usedFallbackFont:
+          type: boolean
+      required:
+        - id
+        - status
+    PdfEditResult:
+      type: object
+      properties:
+        url:
+          type: array
+          items:
+            type: object
+            additionalProperties: true
+      required:
+        - url
+    PdfPreflightFinding:
+      type: object
+      properties:
+        severity:
+          type: string
+          enum:
+            - error
+            - warning
+      required:
+        - severity
+    PdfPreflightResult:
+      type: object
+      properties:
+        url:
+          type: string
+        compliant:
+          type: boolean
+        profile:
+          $ref: "#/components/schemas/PdfXProfile"
+        version:
+          type: string
+        findings:
+          type: array
+          items:
+            $ref: "#/components/schemas/PdfPreflightFinding"
+        stats:
+          type: object
+          additionalProperties: true
+        pageCount:
+          type: number
+        fonts:
+          type: array
+          items:
+            type: object
+            additionalProperties: true
+        spotColours:
+          type: array
+          items:
+            type: string
+        images:
+          type: array
+          items:
+            type: object
+            additionalProperties: true
+        transparency:
+          type: boolean
+        outputIntent:
+          type: object
+          additionalProperties: true
+      required:
+        - url
+        - compliant
+        - profile
+        - version
+        - findings
+        - stats
+        - pageCount
+        - fonts
+        - spotColours
+        - images
+        - transparency
+        - outputIntent
+    PdfPrintReadyResult:
+      type: object
+      properties:
+        url:
+          type: string
+        report:
+          type: object
+          additionalProperties: true
+        compliant:
+          type: boolean
+        profile:
+          $ref: "#/components/schemas/PdfXProfile"
+        outputIntent:
+          type: string
+        findings:
+          type: array
+          items:
+            $ref: "#/components/schemas/PdfPreflightFinding"
+        changes:
+          type: array
+          items:
+            type: object
+            additionalProperties: true
+        before:
+          type: object
+          additionalProperties: true
+        stats:
+          type: object
+          additionalProperties: true
+        note:
+          type: string
+      required:
+        - url
+        - report
+        - compliant
+        - profile
+        - outputIntent
+        - findings
+        - changes
+        - before
+        - stats
+        - note
     ResponsesAgentTrace:
       type: object
       properties:
@@ -17629,8 +17855,19 @@ components:
         - pdf.extract
         - pdf.decodeBarcodes
         - pdf.inspectGraphics
+        - pdf.edit
+        - pdf.preflight
+        - pdf.printReady
         - http.request
         - translate
+    PdfColour:
+      type: object
+      additionalProperties: true
+    PdfXProfile:
+      type: string
+      enum:
+        - pdfx-1a
+        - pdfx-4
     AgentStreamEvent:
       type: object
       additionalProperties: true

package/dist/types/ai.d.ts

@@ -848,7 +848,7 @@ export interface CatalogResponse {
 /** Capability tags a tool requires; scope a run with `allowCapabilities`. */
 export type AiToolCapability = 'web:read' | 'ai:vision' | 'ai:image' | 'ai:text' | 'media:image' | 'media:pdf' | 'net:http';
 /** The names of the built-in server-side agent tools (run via `server_tools`). */
-export type AiToolName = 'web.fetchPage' | 'web.extractSchema' | 'web.screenshot' | 'web.search' | 'brand.assets' | 'document.read' | 'data.extract' | 'image.describe' | 'image.generate' | 'image.fromReference' | 'image.searchStock' | 'image.transform' | 'image.ocr' | 'pdf.create' | 'pdf.fill' | 'pdf.merge' | 'pdf.inspect' | 'pdf.render' | 'pdf.extract' | 'pdf.decodeBarcodes' | 'pdf.inspectGraphics' | 'http.request' | 'translate';
+export type AiToolName = 'web.fetchPage' | 'web.extractSchema' | 'web.screenshot' | 'web.search' | 'brand.assets' | 'document.read' | 'data.extract' | 'image.describe' | 'image.generate' | 'image.fromReference' | 'image.searchStock' | 'image.transform' | 'image.ocr' | 'pdf.create' | 'pdf.fill' | 'pdf.merge' | 'pdf.inspect' | 'pdf.render' | 'pdf.extract' | 'pdf.decodeBarcodes' | 'pdf.inspectGraphics' | 'pdf.edit' | 'pdf.preflight' | 'pdf.printReady' | 'http.request' | 'translate';
 export interface WebFetchPageArgs {
     url: string;
     type?: string;
@@ -993,6 +993,71 @@ export interface PdfInspectGraphicsArgs {
     url: string;
     page?: number;
 }
+/** A box as fractions of the page (0-1), top-left origin. */
+export interface PdfBox {
+    x: number;
+    y: number;
+    w: number;
+    h: number;
+}
+/** CMYK as [c, m, y, k] (0-1 or 0-100), '#RRGGBB', 'cmyk(c,m,y,k)' or 'black'. */
+export type PdfColour = string | [number, number, number, number];
+export interface PdfEditArgs {
+    url: string;
+    /** Live-text replacements; every occurrence on `page` (or all pages when omitted) is replaced. */
+    replaceText?: {
+        id?: string;
+        page?: number;
+        find: string;
+        replace: string;
+        bold?: boolean;
+        align?: 'left' | 'center' | 'right';
+    }[];
+    addText?: {
+        id?: string;
+        page: number;
+        box: PdfBox;
+        text: string;
+        size?: number;
+        bold?: boolean;
+        colour?: PdfColour;
+        align?: 'left' | 'center' | 'right';
+    }[];
+    addImages?: {
+        id?: string;
+        page: number;
+        box: PdfBox;
+        imageUrl: string;
+        colorSpace?: 'rgb' | 'cmyk';
+    }[];
+    /** Draw replacements in the colour of the text they replace (default true). */
+    preserveColour?: boolean;
+}
+export type PdfXProfile = 'pdfx-1a' | 'pdfx-4';
+export interface PdfPreflightArgs {
+    url: string;
+    profile?: PdfXProfile;
+    bleed?: {
+        mm: number;
+    };
+    minDpi?: number;
+}
+export interface PdfPrintReadyArgs {
+    url: string;
+    /** Default 'pdfx-4' (keeps live transparency); 'pdfx-1a' = CMYK + spot only, no transparency. */
+    profile?: PdfXProfile;
+    /** FOGRA39 (default), FOGRA51, FOGRA52, FOGRA29, GRACoL2006, SWOP2006, JapanColor2011. */
+    outputIntent?: string;
+    convertToCmyk?: boolean;
+    embedFonts?: boolean;
+    /** Checked and reported, never added. */
+    bleed?: {
+        mm: number;
+    };
+    /** pdfx-1a only: flatten transparency (affected pages become images). Default false. */
+    flattenTransparency?: boolean;
+    minDpi?: number;
+}
 export interface HttpRequestArgs {
     url: string;
     method?: 'GET' | 'POST' | 'PUT' | 'PATCH' | 'DELETE' | 'HEAD';
@@ -1027,6 +1092,9 @@ export interface AiToolArgsMap {
     'pdf.extract': PdfExtractArgs;
     'pdf.decodeBarcodes': PdfDecodeBarcodesArgs;
     'pdf.inspectGraphics': PdfInspectGraphicsArgs;
+    'pdf.edit': PdfEditArgs;
+    'pdf.preflight': PdfPreflightArgs;
+    'pdf.printReady': PdfPrintReadyArgs;
     'http.request': HttpRequestArgs;
     'translate': TranslateArgs;
 }
@@ -1215,6 +1283,82 @@ export interface PdfInspectGraphicsResult {
     spotColours: string[];
     note: string;
 }
+export interface PdfEditItemResult {
+    id: string;
+    status: 'done' | 'failed';
+    note?: string;
+    /** replaceText: the new text reads back from the output as live text and the old text is gone. */
+    verified?: boolean;
+    /** replaceText: drawn in the embedded fallback font (original font lacked glyphs, or bold was asked). */
+    usedFallbackFont?: boolean;
+}
+export interface PdfEditResult {
+    url: string;
+    results: PdfEditItemResult[];
+    warnings: string[];
+}
+export interface PdfPreflightFinding {
+    severity: 'error' | 'warning';
+    code: string;
+    page?: number;
+    message: string;
+}
+export interface PdfPreflightResult {
+    url: string;
+    compliant: boolean;
+    profile: PdfXProfile | null;
+    version: string | null;
+    findings: PdfPreflightFinding[];
+    stats: {
+        pageCount: number;
+        fonts: {
+            name: string;
+            embedded: boolean;
+            subset: boolean;
+            type: string;
+            pages: number[];
+        }[];
+        spotColours: string[];
+        images: {
+            page: number;
+            dpi: number;
+            width: number;
+            height: number;
+            space: string;
+            placedMm: {
+                w: number;
+                h: number;
+            };
+        }[];
+        transparency: boolean;
+        outputIntent: {
+            identifier: string | null;
+            hasProfile: boolean;
+        } | null;
+        [key: string]: any;
+    };
+}
+export interface PdfPrintReadyResult {
+    url: string;
+    report: {
+        /** From the post-conversion preflight — never assumed. */
+        compliant: boolean;
+        profile: PdfXProfile;
+        outputIntent: string;
+        findings: PdfPreflightFinding[];
+        changes: {
+            code: string;
+            message: string;
+        }[];
+        before: {
+            compliant: boolean;
+            errors: number;
+            findings: PdfPreflightFinding[];
+        };
+        stats: Record<string, any>;
+        note: string;
+    };
+}
 /** The `_agent` trace attached to an agentic Responses result. */
 export interface ResponsesAgentTrace {
     steps: number;