@wix/auto_sdk_online-programs_programs 1.0.42 → 1.0.43
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/build/cjs/index.d.ts +2 -2
- package/build/cjs/index.js.map +1 -1
- package/build/cjs/index.typings.d.ts +2 -2
- package/build/cjs/index.typings.js.map +1 -1
- package/build/cjs/meta.d.ts +105 -44
- package/build/cjs/meta.js.map +1 -1
- package/build/cjs/{online-programs-v3-program-programs.universal-CXWw_Yap.d.ts → online-programs-v3-program-programs.universal-Lt33oe5u.d.ts} +104 -43
- package/build/es/index.d.mts +2 -2
- package/build/es/index.mjs.map +1 -1
- package/build/es/index.typings.d.mts +2 -2
- package/build/es/index.typings.mjs.map +1 -1
- package/build/es/meta.d.mts +105 -44
- package/build/es/meta.mjs.map +1 -1
- package/build/es/{online-programs-v3-program-programs.universal-CXWw_Yap.d.mts → online-programs-v3-program-programs.universal-Lt33oe5u.d.mts} +104 -43
- package/build/internal/cjs/index.d.ts +2 -2
- package/build/internal/cjs/index.typings.d.ts +2 -2
- package/build/internal/cjs/meta.d.ts +105 -44
- package/build/internal/cjs/{online-programs-v3-program-programs.universal-C2QeyOXB.d.ts → online-programs-v3-program-programs.universal-DJ1omkE9.d.ts} +104 -43
- package/build/internal/es/index.d.mts +2 -2
- package/build/internal/es/index.typings.d.mts +2 -2
- package/build/internal/es/meta.d.mts +105 -44
- package/build/internal/es/{online-programs-v3-program-programs.universal-C2QeyOXB.d.mts → online-programs-v3-program-programs.universal-DJ1omkE9.d.mts} +104 -43
- package/package.json +4 -4
package/build/es/meta.d.mts
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import { aH as CreateProgramRequest$1, aI as CreateProgramResponse$1, aS as DuplicateProgramRequest$1, D as DuplicateProgramResponse$1, aT as GetProgramRequest$1, aU as GetProgramResponse$1, aV as UpdateProgramRequest$1, aW as UpdateProgramResponse$1, b0 as DeleteProgramRequest$1, b1 as DeleteProgramResponse$1, b2 as QueryProgramsRequest$1, b8 as QueryProgramsResponse$1, bb as SearchProgramsRequest$1, S as SearchProgramsResponse$1, bP as PublishProgramRequest$1, c as PublishProgramResponse$1, bQ as EndProgramRequest$1, E as EndProgramResponse$1, bR as ArchiveProgramRequest$1, A as ArchiveProgramResponse$1, bS as EnableProgramFreemiumRequest$1, bT as EnableProgramFreemiumResponse$1, bU as DisableProgramFreemiumRequest$1, bV as DisableProgramFreemiumResponse$1, bW as BulkUpdateProgramsRequest$1, e as BulkUpdateProgramsResponse$1, bY as CountProgramsRequest$1, f as CountProgramsResponse$1, bZ as ListSampleProgramsRequest$1, L as ListSampleProgramsResponse$1 } from './online-programs-v3-program-programs.universal-
|
|
1
|
+
import { aH as CreateProgramRequest$1, aI as CreateProgramResponse$1, aS as DuplicateProgramRequest$1, D as DuplicateProgramResponse$1, aT as GetProgramRequest$1, aU as GetProgramResponse$1, aV as UpdateProgramRequest$1, aW as UpdateProgramResponse$1, b0 as DeleteProgramRequest$1, b1 as DeleteProgramResponse$1, b2 as QueryProgramsRequest$1, b8 as QueryProgramsResponse$1, bb as SearchProgramsRequest$1, S as SearchProgramsResponse$1, bP as PublishProgramRequest$1, c as PublishProgramResponse$1, bQ as EndProgramRequest$1, E as EndProgramResponse$1, bR as ArchiveProgramRequest$1, A as ArchiveProgramResponse$1, bS as EnableProgramFreemiumRequest$1, bT as EnableProgramFreemiumResponse$1, bU as DisableProgramFreemiumRequest$1, bV as DisableProgramFreemiumResponse$1, bW as BulkUpdateProgramsRequest$1, e as BulkUpdateProgramsResponse$1, bY as CountProgramsRequest$1, f as CountProgramsResponse$1, bZ as ListSampleProgramsRequest$1, L as ListSampleProgramsResponse$1 } from './online-programs-v3-program-programs.universal-Lt33oe5u.mjs';
|
|
2
2
|
import '@wix/sdk-types';
|
|
3
3
|
|
|
4
4
|
/**
|
|
@@ -266,73 +266,117 @@ interface Seo {
|
|
|
266
266
|
courseWorkload?: string;
|
|
267
267
|
}
|
|
268
268
|
/**
|
|
269
|
-
* The SEO
|
|
270
|
-
*
|
|
271
|
-
*
|
|
269
|
+
* The SEO data for a single page or dynamic item, in the shape stored today.
|
|
270
|
+
*
|
|
271
|
+
* FROZEN. Existing server code maps onto this message field by field, so its
|
|
272
|
+
* field set must never change (see the file header). New writers use
|
|
273
|
+
* `SeoSchemaV2`.
|
|
274
|
+
*
|
|
275
|
+
* These tags are rendered into the <head> of the HTML document and are not
|
|
276
|
+
* visible on the page itself. They override every other source of tags
|
|
277
|
+
* (site defaults, vertical presets, patterns) for this page.
|
|
272
278
|
*/
|
|
273
279
|
interface SeoSchema {
|
|
274
|
-
/**
|
|
280
|
+
/**
|
|
281
|
+
* The tags rendered into <head>, in no particular order. Render order is
|
|
282
|
+
* decided by the renderer, not by position in this list.
|
|
283
|
+
*
|
|
284
|
+
* No maxSize: this list is already populated by data written years ago, and
|
|
285
|
+
* a bound added now could reject a page that is already stored.
|
|
286
|
+
*/
|
|
275
287
|
tags?: Tag[];
|
|
276
|
-
/** SEO
|
|
288
|
+
/** Page-level SEO settings that are not themselves tags. */
|
|
277
289
|
settings?: Settings;
|
|
278
290
|
}
|
|
291
|
+
/** A keyword term the user is targeting. */
|
|
279
292
|
interface Keyword {
|
|
280
|
-
/**
|
|
293
|
+
/**
|
|
294
|
+
* The term itself, e.g. "trail running shoes".
|
|
295
|
+
*
|
|
296
|
+
* No maxLength, for the same reason as the legacy tag fields: keywords are
|
|
297
|
+
* already stored, and a bound added now could reject a record written
|
|
298
|
+
* before the bound existed. The flynt `missing-string-validations` warning
|
|
299
|
+
* on this field is accepted deliberately.
|
|
300
|
+
*/
|
|
281
301
|
term?: string;
|
|
282
|
-
/** Whether
|
|
302
|
+
/** Whether this is the page's primary focus keyword. At most one per page. */
|
|
283
303
|
isMain?: boolean;
|
|
284
304
|
/**
|
|
285
|
-
*
|
|
305
|
+
* Which surface added the term, e.g. a panel or a suggestion flow. Used for
|
|
306
|
+
* attribution in BI. Opaque to the renderer.
|
|
286
307
|
* @maxLength 1000
|
|
287
308
|
*/
|
|
288
309
|
origin?: string | null;
|
|
289
310
|
}
|
|
311
|
+
/**
|
|
312
|
+
* One tag in the page's <head>.
|
|
313
|
+
*
|
|
314
|
+
* Not deprecated, and with no removal date, deliberately: stored data is
|
|
315
|
+
* never migrated, so this shape stays valid input forever. `seo-renderer`
|
|
316
|
+
* normalizes both shapes on READ.
|
|
317
|
+
*/
|
|
290
318
|
interface Tag {
|
|
291
319
|
/**
|
|
292
|
-
*
|
|
293
|
-
*
|
|
294
|
-
*
|
|
295
|
-
* Supported values: `title`, `meta`, `script`, `link`.
|
|
320
|
+
* Legacy. Was a free-form string: "title" | "meta" | "script" | "link".
|
|
321
|
+
* The typed replacement is the `kind` oneof on `SeoSchemaV2.Tag`, which makes
|
|
322
|
+
* the invalid combinations unrepresentable rather than merely discouraged.
|
|
296
323
|
*
|
|
297
|
-
* Which of these an API actually accepts depends on where the tag is being
|
|
298
|
-
* list is not a blanket guarantee across every API that reuses
|
|
299
|
-
* Tags in particular accepts only `meta` (see
|
|
300
|
-
* `title`/`script`/`link` with a validation
|
|
301
|
-
*
|
|
302
|
-
*
|
|
324
|
+
* Which of these an API actually accepts depends on where the tag is being
|
|
325
|
+
* set: this list is not a blanket guarantee across every API that reuses
|
|
326
|
+
* this message. Site SEO Tags in particular accepts only `meta` (see
|
|
327
|
+
* `SiteSeoTags.tags`) and rejects `title`/`script`/`link` with a validation
|
|
328
|
+
* error even though they appear here — check the field description of the
|
|
329
|
+
* specific `tags`-typed field you are writing to.
|
|
303
330
|
*
|
|
304
331
|
* Limitation: `title` and `script` (e.g. a `script` tag with `props.type`
|
|
305
|
-
*
|
|
306
|
-
* `custom` is unset or `false`. Setting `custom: true` on a `title` or
|
|
307
|
-
* tag is rejected with `TAG_TYPE_NOT_ALLOWED`, because
|
|
308
|
-
* write through the site's Advanced/Custom Tags
|
|
309
|
-
* omit `custom` (or set it to `false`).
|
|
332
|
+
* "application/ld+json" carrying structured data) are supported only when
|
|
333
|
+
* `custom` is unset or `false`. Setting `custom: true` on a `title` or
|
|
334
|
+
* `script` tag is rejected with `TAG_TYPE_NOT_ALLOWED`, because
|
|
335
|
+
* `custom: true` routes the write through the site's Advanced/Custom Tags
|
|
336
|
+
* list. To write structured data, omit `custom` (or set it to `false`).
|
|
337
|
+
*
|
|
338
|
+
* No length limit: this field holds data written years ago by writers we
|
|
339
|
+
* are not migrating. A constraint here could reject a record that is
|
|
340
|
+
* already stored, which is exactly the promise this design makes.
|
|
310
341
|
*/
|
|
311
342
|
type?: string;
|
|
312
343
|
/**
|
|
313
|
-
*
|
|
314
|
-
*
|
|
344
|
+
* Legacy. Was an untyped bag of HTML attributes.
|
|
345
|
+
* Typed replacement: `SeoSchemaV2.TitleTag` / `MetaTag` / `LinkTag`.
|
|
315
346
|
*/
|
|
316
347
|
props?: Record<string, any> | null;
|
|
317
|
-
/**
|
|
348
|
+
/**
|
|
349
|
+
* Legacy. Was an untyped bag of 16 mixed-purpose keys. In `SeoSchemaV2`
|
|
350
|
+
* its contents are split by purpose: per-page structured-data state moves to
|
|
351
|
+
* StructuredDataTag, authorship to `written_by`, and render-time preset
|
|
352
|
+
* logic (variants, enabledByExperiment, removeSchemaIf*) moved out of the
|
|
353
|
+
* stored document entirely — it belongs to the preset definition, not to the
|
|
354
|
+
* page. See the design log for the full key-by-key mapping.
|
|
355
|
+
*/
|
|
318
356
|
meta?: Record<string, any> | null;
|
|
319
|
-
/**
|
|
357
|
+
/**
|
|
358
|
+
* Legacy. Was the tag's inner content, doubling as the JSON-LD payload
|
|
359
|
+
* for script tags. Typed replacement: `SeoSchemaV2.TitleTag.text` and
|
|
360
|
+
* `StructuredDataTag.json_ld`.
|
|
361
|
+
* No length limit, for the same reason as `type` above.
|
|
362
|
+
*/
|
|
320
363
|
children?: string;
|
|
321
364
|
/**
|
|
322
365
|
* Whether the tag is a [custom tag](https://support.wix.com/en/article/adding-additional-meta-tags-to-your-sites-pages) —
|
|
323
366
|
* i.e. an entry from the site's Advanced/Custom Tags list.
|
|
324
367
|
*
|
|
325
|
-
* Setting this to `true` on a write restricts which `type` values are
|
|
326
|
-
* — the same restriction the Advanced/Custom Tags UI enforces.
|
|
327
|
-
* `script` tags (including JSON-LD structured data) must be sent
|
|
328
|
-
* omitted or `false`; sending them with `custom: true` is
|
|
329
|
-
* `TAG_TYPE_NOT_ALLOWED`.
|
|
368
|
+
* Setting this to `true` on a write restricts which `type` values are
|
|
369
|
+
* accepted — the same restriction the Advanced/Custom Tags UI enforces.
|
|
370
|
+
* `title` and `script` tags (including JSON-LD structured data) must be sent
|
|
371
|
+
* with `custom` omitted or `false`; sending them with `custom: true` is
|
|
372
|
+
* rejected with `TAG_TYPE_NOT_ALLOWED`.
|
|
330
373
|
*
|
|
331
|
-
* Note this is a separate restriction from Site SEO Tags' own type
|
|
332
|
-
* `SiteSeoTags.tags`: even with `custom` unset, Site SEO Tags
|
|
333
|
-
* for site-wide structured data) unconditionally.
|
|
334
|
-
* site-wide, every-page structured data
|
|
335
|
-
* `script` tag through the Item
|
|
374
|
+
* Note this is a separate restriction from Site SEO Tags' own type
|
|
375
|
+
* restriction on `SiteSeoTags.tags`: even with `custom` unset, Site SEO Tags
|
|
376
|
+
* rejects `script` (e.g. for site-wide structured data) unconditionally.
|
|
377
|
+
* There is currently no way to set site-wide, every-page structured data
|
|
378
|
+
* through any of these APIs — write a per-page `script` tag through the Item
|
|
379
|
+
* SEO Tags API instead.
|
|
336
380
|
*
|
|
337
381
|
* This flag is scoped to that feature only. It is NOT an indicator of whether a standard tag
|
|
338
382
|
* (`title`, `description`, Open Graph, etc.) reflects a manually configured value versus a computed
|
|
@@ -345,22 +389,39 @@ interface Tag {
|
|
|
345
389
|
* or Wix Studio pages, so even genuine Advanced/Custom Tags saved on those pages are missing from the
|
|
346
390
|
* response entirely — there, `false` means this API could not tell, not that no custom tag exists.
|
|
347
391
|
* Pass `seoData` explicitly to resolve against a known set of tags.
|
|
392
|
+
*
|
|
393
|
+
* `SeoSchemaV2.Tag` expresses this as `written_by = USER_CUSTOM`.
|
|
348
394
|
*/
|
|
349
395
|
custom?: boolean;
|
|
350
|
-
/**
|
|
396
|
+
/**
|
|
397
|
+
* Whether the tag is excluded from the rendered <head>.
|
|
398
|
+
*
|
|
399
|
+
* A disabled tag is still stored, so the user can re-enable it and so a
|
|
400
|
+
* pattern-provided tag stays suppressed on this page. Default false.
|
|
401
|
+
*/
|
|
351
402
|
disabled?: boolean;
|
|
352
403
|
}
|
|
404
|
+
/** Page-level SEO settings that are not tags. */
|
|
353
405
|
interface Settings {
|
|
354
406
|
/**
|
|
355
|
-
* Whether the
|
|
407
|
+
* Whether to suppress the automatic redirect from this page's previous URL to
|
|
408
|
+
* its current one after a slug change.
|
|
356
409
|
*
|
|
357
|
-
*
|
|
358
|
-
*
|
|
410
|
+
* Default false, meaning the redirect IS created. The field is named for the
|
|
411
|
+
* exception rather than the rule, which reads backwards; kept as-is because
|
|
412
|
+
* renaming a stored boolean is not worth the migration.
|
|
359
413
|
*/
|
|
360
414
|
preventAutoRedirect?: boolean;
|
|
361
415
|
/**
|
|
362
|
-
*
|
|
363
|
-
*
|
|
416
|
+
* Keyword terms the user is targeting for this page. Used by the SEO
|
|
417
|
+
* assistant and checklist; never rendered into <head>.
|
|
418
|
+
*
|
|
419
|
+
* 20 is a sanity bound, not the product limit. v1 declared 5 — the number
|
|
420
|
+
* the panel happens to allow today — which is exactly the mistake we are
|
|
421
|
+
* fixing for structured data. A product decision to allow 8 should not need
|
|
422
|
+
* a proto release, so the panel owns that number and the proto only stops
|
|
423
|
+
* something absurd.
|
|
424
|
+
* @maxSize 20
|
|
364
425
|
*/
|
|
365
426
|
keywords?: Keyword[];
|
|
366
427
|
}
|