@wix/auto_sdk_seo_page-optimization 1.0.0

package/build/internal/es/meta.d.mts

@@ -0,0 +1,224 @@
+import { TriggerPageOptimizationRequest as TriggerPageOptimizationRequest$1, TriggerPageOptimizationResponse as TriggerPageOptimizationResponse$1, TriggerHomePageOptimizationRequest as TriggerHomePageOptimizationRequest$1, TriggerHomePageOptimizationResponse as TriggerHomePageOptimizationResponse$1, GetPageOptimizationResultsRequest as GetPageOptimizationResultsRequest$1, GetPageOptimizationResultsResponse as GetPageOptimizationResultsResponse$1 } from './index.typings.mjs';
+import '@wix/sdk-types';
+
+/**
+ * A whole-page set of SEO optimization suggestions, generated for one page
+ * and focus keyword.
+ *
+ * Each suggestion is a before/after pair: `before` is the page's current
+ * text (empty when the page has none, such as a missing meta description),
+ * and `after` is the suggested replacement. Locate the element to change by
+ * its `before` text.
+ */
+interface PageOptimization {
+    /**
+     * ID of this suggestion set.
+     * @format GUID
+     * @readonly
+     */
+    id?: string | null;
+    /**
+     * Suggested title tag.
+     * @readonly
+     */
+    metaTitle?: TextSuggestion;
+    /**
+     * Suggested description tag.
+     * @readonly
+     */
+    metaDescription?: TextSuggestion;
+    /**
+     * Suggested H1 heading.
+     * @readonly
+     */
+    h1?: TextSuggestion;
+    /**
+     * Suggested H2 or H3 heading.
+     * @readonly
+     */
+    h2OrH3?: TextSuggestion;
+    /**
+     * Suggested body text rewrites.
+     * @readonly
+     * @maxSize 100
+     */
+    content?: TextSuggestion[];
+}
+/** One suggested text change. */
+interface TextSuggestion {
+    /**
+     * The page's current text. Empty when the page has no text in this slot —
+     * for example, a missing meta description.
+     * @readonly
+     * @maxLength 1000
+     */
+    before?: string | null;
+    /**
+     * The suggested text.
+     * @readonly
+     * @maxLength 1000
+     */
+    after?: string;
+}
+interface TriggerPageOptimizationRequest {
+    /**
+     * ID of the site page to optimize.
+     * @maxLength 1000
+     * @minLength 1
+     */
+    pageId: string;
+    /**
+     * URL path of the page, relative to the site's domain. For example,
+     * `/about`.
+     * @maxLength 1000
+     * @minLength 1
+     */
+    pagePath: string;
+}
+interface TriggerPageOptimizationResponse {
+    /**
+     * ID of the generation job. Pass to Get Page Optimization Results.
+     * @readonly
+     * @maxLength 200
+     */
+    predictionId?: string;
+}
+interface TriggerHomePageOptimizationRequest {
+    /**
+     * ID of the site's homepage.
+     * @maxLength 1000
+     * @minLength 1
+     */
+    pageId: string;
+    /**
+     * URL path of the homepage. Usually `/`.
+     * @maxLength 1000
+     * @minLength 1
+     */
+    pagePath: string;
+}
+interface TriggerHomePageOptimizationResponse {
+    /**
+     * ID of the generation job. Pass to Get Page Optimization Results.
+     * @readonly
+     * @maxLength 200
+     */
+    predictionId?: string;
+}
+interface GetPageOptimizationResultsRequest {
+    /**
+     * ID of the generation job, from the trigger call.
+     * @maxLength 200
+     */
+    predictionId?: string | null;
+    /**
+     * ID of the page to retrieve suggestions for. An alternative to
+     * `predictionId` — returns the page's latest generation.
+     * @maxLength 1000
+     */
+    pageId?: string | null;
+}
+interface GetPageOptimizationResultsResponse {
+    /** The generated suggestions. Returned only when `status` is `COMPLETED`. */
+    pageOptimization?: PageOptimization;
+    /**
+     * Status of the generation job the lookup matched.
+     * @readonly
+     */
+    status?: OptimizationStatusWithLiterals;
+}
+/** Status of a page optimization generation job. */
+declare enum OptimizationStatus {
+    UNKNOWN_OPTIMIZATION_STATUS = "UNKNOWN_OPTIMIZATION_STATUS",
+    /**
+     * No generation job matches the lookup — it never existed, or a later
+     * trigger for the same page replaced it.
+     */
+    NOT_FOUND = "NOT_FOUND",
+    /** Generation is still running. Poll again. */
+    IN_PROGRESS = "IN_PROGRESS",
+    /** Generation finished; the response carries the suggestions. */
+    COMPLETED = "COMPLETED",
+    /** Generation failed. Trigger again to retry. */
+    FAILED = "FAILED"
+}
+/** @enumType */
+type OptimizationStatusWithLiterals = OptimizationStatus | 'UNKNOWN_OPTIMIZATION_STATUS' | 'NOT_FOUND' | 'IN_PROGRESS' | 'COMPLETED' | 'FAILED';
+/** @docsIgnore */
+type TriggerPageOptimizationApplicationErrors = {
+    code?: 'SITE_NOT_SUPPORTED';
+    description?: string;
+    data?: Record<string, any>;
+} | {
+    code?: 'FOCUS_KEYWORD_NOT_SET';
+    description?: string;
+    data?: Record<string, any>;
+} | {
+    code?: 'CONTENT_TOO_SHORT';
+    description?: string;
+    data?: Record<string, any>;
+} | {
+    code?: 'SUGGESTIONS_ALREADY_IN_PROGRESS';
+    description?: string;
+    data?: Record<string, any>;
+} | {
+    code?: 'GENERATION_FAILED';
+    description?: string;
+    data?: Record<string, any>;
+} | {
+    code?: 'QUOTA_LIMIT_REACHED';
+    description?: string;
+    data?: Record<string, any>;
+};
+/** @docsIgnore */
+type TriggerHomePageOptimizationApplicationErrors = {
+    code?: 'SITE_NOT_SUPPORTED';
+    description?: string;
+    data?: Record<string, any>;
+} | {
+    code?: 'FOCUS_KEYWORD_NOT_SET';
+    description?: string;
+    data?: Record<string, any>;
+} | {
+    code?: 'CONTENT_TOO_SHORT';
+    description?: string;
+    data?: Record<string, any>;
+} | {
+    code?: 'SUGGESTIONS_ALREADY_IN_PROGRESS';
+    description?: string;
+    data?: Record<string, any>;
+} | {
+    code?: 'GENERATION_FAILED';
+    description?: string;
+    data?: Record<string, any>;
+} | {
+    code?: 'QUOTA_LIMIT_REACHED';
+    description?: string;
+    data?: Record<string, any>;
+};
+/** @docsIgnore */
+type GetPageOptimizationResultsApplicationErrors = {
+    code?: 'GENERATION_FAILED';
+    description?: string;
+    data?: Record<string, any>;
+} | {
+    code?: 'QUOTA_LIMIT_REACHED';
+    description?: string;
+    data?: Record<string, any>;
+};
+
+type __PublicMethodMetaInfo<K = string, M = unknown, T = unknown, S = unknown, Q = unknown, R = unknown> = {
+    getUrl: (context: any) => string;
+    httpMethod: K;
+    path: string;
+    pathParams: M;
+    __requestType: T;
+    __originalRequestType: S;
+    __responseType: Q;
+    __originalResponseType: R;
+};
+declare function triggerPageOptimization(): __PublicMethodMetaInfo<'POST', {}, TriggerPageOptimizationRequest$1, TriggerPageOptimizationRequest, TriggerPageOptimizationResponse$1, TriggerPageOptimizationResponse>;
+declare function triggerHomePageOptimization(): __PublicMethodMetaInfo<'POST', {}, TriggerHomePageOptimizationRequest$1, TriggerHomePageOptimizationRequest, TriggerHomePageOptimizationResponse$1, TriggerHomePageOptimizationResponse>;
+declare function getPageOptimizationResults(): __PublicMethodMetaInfo<'GET', {}, GetPageOptimizationResultsRequest$1, GetPageOptimizationResultsRequest, GetPageOptimizationResultsResponse$1, GetPageOptimizationResultsResponse>;
+
+export { type GetPageOptimizationResultsApplicationErrors as GetPageOptimizationResultsApplicationErrorsOriginal, type GetPageOptimizationResultsRequest as GetPageOptimizationResultsRequestOriginal, type GetPageOptimizationResultsResponse as GetPageOptimizationResultsResponseOriginal, OptimizationStatus as OptimizationStatusOriginal, type OptimizationStatusWithLiterals as OptimizationStatusWithLiteralsOriginal, type PageOptimization as PageOptimizationOriginal, type TextSuggestion as TextSuggestionOriginal, type TriggerHomePageOptimizationApplicationErrors as TriggerHomePageOptimizationApplicationErrorsOriginal, type TriggerHomePageOptimizationRequest as TriggerHomePageOptimizationRequestOriginal, type TriggerHomePageOptimizationResponse as TriggerHomePageOptimizationResponseOriginal, type TriggerPageOptimizationApplicationErrors as TriggerPageOptimizationApplicationErrorsOriginal, type TriggerPageOptimizationRequest as TriggerPageOptimizationRequestOriginal, type TriggerPageOptimizationResponse as TriggerPageOptimizationResponseOriginal, type __PublicMethodMetaInfo, getPageOptimizationResults, triggerHomePageOptimization, triggerPageOptimization };

package/meta/package.json

@@ -0,0 +1,3 @@
+{
+  "main": "../build/cjs/meta.js"
+}

package/package.json

@@ -0,0 +1,54 @@
+{
+  "name": "@wix/auto_sdk_seo_page-optimization",
+  "version": "1.0.0",
+  "license": "MIT",
+  "publishConfig": {
+    "registry": "https://registry.npmjs.org/",
+    "access": "public"
+  },
+  "keywords": [],
+  "sideEffects": false,
+  "main": "./build/cjs/index.js",
+  "types": "./build/cjs/index.d.ts",
+  "exports": {
+    ".": {
+      "import": "./build/es/index.mjs",
+      "require": "./build/cjs/index.js",
+      "types": "./build/es/index.d.mts"
+    },
+    "./package.json": "./package.json",
+    "./meta": {
+      "import": "./build/es/meta.mjs",
+      "require": "./build/cjs/meta.js",
+      "types": "./build/es/meta.d.mts"
+    }
+  },
+  "files": [
+    "build",
+    "meta",
+    "service-plugins"
+  ],
+  "dependencies": {
+    "@wix/sdk-runtime": "^1.0.24",
+    "@wix/sdk-types": "^1.17.11"
+  },
+  "devDependencies": {
+    "tsup": "^8.4.0",
+    "typescript": "^5.3.2"
+  },
+  "scripts": {
+    "build": "tsup",
+    "test": ":"
+  },
+  "wix": {
+    "artifact": {
+      "artifactId": "auto-sdk-seo-page-optimization",
+      "groupId": "com.wixpress.public-sdk-dependencies"
+    },
+    "sdkDependency": {
+      "fqdnNamespace": "pageOptimization",
+      "fqdn": "wix.seo.suggestions.v1.page_optimization"
+    }
+  },
+  "falconPackageHash": "1111cf88f4c87271e3e5af766a0e1f258249ff74ca9014705b3435d3"
+}