@xylabs/sdk-meta 4.13.13 → 4.13.15

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.
Files changed (35) hide show
  1. package/build/neutral/html/index.d.ts +2 -0
  2. package/build/neutral/html/index.d.ts.map +1 -0
  3. package/build/neutral/html/mergeDocumentHead.d.ts +2 -0
  4. package/build/neutral/html/mergeDocumentHead.d.ts.map +1 -0
  5. package/build/neutral/index.d.ts +5 -0
  6. package/build/neutral/index.d.ts.map +1 -0
  7. package/build/neutral/lib/getMetaAsDict.d.ts +5 -0
  8. package/build/neutral/lib/getMetaAsDict.d.ts.map +1 -0
  9. package/build/neutral/lib/index.d.ts +2 -0
  10. package/build/neutral/lib/index.d.ts.map +1 -0
  11. package/build/neutral/meta/builder.d.ts +3 -0
  12. package/build/neutral/meta/builder.d.ts.map +1 -0
  13. package/build/neutral/meta/index.d.ts +2 -0
  14. package/build/neutral/meta/index.d.ts.map +1 -0
  15. package/build/neutral/models/Meta.d.ts +9 -0
  16. package/build/neutral/models/Meta.d.ts.map +1 -0
  17. package/build/neutral/models/OpenGraph/OpenGraphMeta.d.ts +14 -0
  18. package/build/neutral/models/OpenGraph/OpenGraphMeta.d.ts.map +1 -0
  19. package/build/neutral/models/OpenGraph/OpenGraphStructured.d.ts +10 -0
  20. package/build/neutral/models/OpenGraph/OpenGraphStructured.d.ts.map +1 -0
  21. package/build/neutral/models/OpenGraph/OpenGraphStructuredProperty.d.ts +3 -0
  22. package/build/neutral/models/OpenGraph/OpenGraphStructuredProperty.d.ts.map +1 -0
  23. package/build/neutral/models/OpenGraph/index.d.ts +4 -0
  24. package/build/neutral/models/OpenGraph/index.d.ts.map +1 -0
  25. package/build/neutral/models/Twitter/Twitter.d.ts +66 -0
  26. package/build/neutral/models/Twitter/Twitter.d.ts.map +1 -0
  27. package/build/neutral/models/Twitter/TwitterApp.d.ts +18 -0
  28. package/build/neutral/models/Twitter/TwitterApp.d.ts.map +1 -0
  29. package/build/neutral/models/Twitter/TwitterPlayer.d.ts +24 -0
  30. package/build/neutral/models/Twitter/TwitterPlayer.d.ts.map +1 -0
  31. package/build/neutral/models/Twitter/index.d.ts +4 -0
  32. package/build/neutral/models/Twitter/index.d.ts.map +1 -0
  33. package/build/neutral/models/index.d.ts +4 -0
  34. package/build/neutral/models/index.d.ts.map +1 -0
  35. package/package.json +4 -4
@@ -0,0 +1,2 @@
1
+ export * from './mergeDocumentHead.ts';
2
+ //# sourceMappingURL=index.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/html/index.ts"],"names":[],"mappings":"AAAA,cAAc,wBAAwB,CAAA"}
@@ -0,0 +1,2 @@
1
+ export declare const mergeDocumentHead: (destination: string, source: string) => string;
2
+ //# sourceMappingURL=mergeDocumentHead.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"mergeDocumentHead.d.ts","sourceRoot":"","sources":["../../../src/html/mergeDocumentHead.ts"],"names":[],"mappings":"AAMA,eAAO,MAAM,iBAAiB,GAAI,aAAa,MAAM,EAAE,QAAQ,MAAM,WAwCpE,CAAA"}
@@ -0,0 +1,5 @@
1
+ export * from './html/index.ts';
2
+ export * from './lib/index.ts';
3
+ export * from './meta/index.ts';
4
+ export * from './models/index.ts';
5
+ //# sourceMappingURL=index.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,iBAAiB,CAAA;AAC/B,cAAc,gBAAgB,CAAA;AAC9B,cAAc,iBAAiB,CAAA;AAC/B,cAAc,mBAAmB,CAAA"}
@@ -0,0 +1,5 @@
1
+ export type StringIndexable = {
2
+ [key: string]: any;
3
+ };
4
+ export declare const getMetaAsDict: (obj: StringIndexable, parentKey?: string) => Record<string, string>;
5
+ //# sourceMappingURL=getMetaAsDict.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"getMetaAsDict.d.ts","sourceRoot":"","sources":["../../../src/lib/getMetaAsDict.ts"],"names":[],"mappings":"AAEA,MAAM,MAAM,eAAe,GAAG;IAAE,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAA;CAAE,CAAA;AAIpD,eAAO,MAAM,aAAa,GAAI,KAAK,eAAe,EAAE,YAAY,MAAM,KAAG,MAAM,CAAC,MAAM,EAAE,MAAM,CAe7F,CAAA"}
@@ -0,0 +1,2 @@
1
+ export * from './getMetaAsDict.ts';
2
+ //# sourceMappingURL=index.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/lib/index.ts"],"names":[],"mappings":"AAAA,cAAc,oBAAoB,CAAA"}
@@ -0,0 +1,3 @@
1
+ import type { Meta } from '../models/index.ts';
2
+ export declare const metaBuilder: (html: string, meta: Meta, handler?: string) => string;
3
+ //# sourceMappingURL=builder.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"builder.d.ts","sourceRoot":"","sources":["../../../src/meta/builder.ts"],"names":[],"mappings":"AAKA,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,oBAAoB,CAAA;AA4B9C,eAAO,MAAM,WAAW,GAAI,MAAM,MAAM,EAAE,MAAM,IAAI,EAAE,UAAU,MAAM,WAmBrE,CAAA"}
@@ -0,0 +1,2 @@
1
+ export * from './builder.ts';
2
+ //# sourceMappingURL=index.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/meta/index.ts"],"names":[],"mappings":"AAAA,cAAc,cAAc,CAAA"}
@@ -0,0 +1,9 @@
1
+ import type { OpenGraphMeta } from './OpenGraph/index.ts';
2
+ import type { TwitterMeta } from './Twitter/index.ts';
3
+ export interface Meta {
4
+ description?: string;
5
+ og?: OpenGraphMeta;
6
+ title?: string;
7
+ twitter?: TwitterMeta;
8
+ }
9
+ //# sourceMappingURL=Meta.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"Meta.d.ts","sourceRoot":"","sources":["../../../src/models/Meta.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,sBAAsB,CAAA;AACzD,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,oBAAoB,CAAA;AAErD,MAAM,WAAW,IAAI;IACnB,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB,EAAE,CAAC,EAAE,aAAa,CAAA;IAClB,KAAK,CAAC,EAAE,MAAM,CAAA;IACd,OAAO,CAAC,EAAE,WAAW,CAAA;CACtB"}
@@ -0,0 +1,14 @@
1
+ import type { OpenGraphStructuredProperty } from './OpenGraphStructuredProperty.ts';
2
+ export interface OpenGraphMeta {
3
+ audio?: OpenGraphStructuredProperty;
4
+ description?: string;
5
+ determiner?: string;
6
+ image?: OpenGraphStructuredProperty;
7
+ locale?: string | string[];
8
+ site_name?: string;
9
+ title?: string;
10
+ type?: string;
11
+ url?: string;
12
+ video?: OpenGraphStructuredProperty;
13
+ }
14
+ //# sourceMappingURL=OpenGraphMeta.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"OpenGraphMeta.d.ts","sourceRoot":"","sources":["../../../../src/models/OpenGraph/OpenGraphMeta.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,2BAA2B,EAAE,MAAM,kCAAkC,CAAA;AAKnF,MAAM,WAAW,aAAa;IAC5B,KAAK,CAAC,EAAE,2BAA2B,CAAA;IACnC,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB,UAAU,CAAC,EAAE,MAAM,CAAA;IACnB,KAAK,CAAC,EAAE,2BAA2B,CAAA;IACnC,MAAM,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,CAAA;IAC1B,SAAS,CAAC,EAAE,MAAM,CAAA;IAClB,KAAK,CAAC,EAAE,MAAM,CAAA;IACd,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,GAAG,CAAC,EAAE,MAAM,CAAA;IACZ,KAAK,CAAC,EAAE,2BAA2B,CAAA;CACpC"}
@@ -0,0 +1,10 @@
1
+ export interface OpenGraphStructured {
2
+ ''?: string;
3
+ 'alt'?: string;
4
+ 'height'?: number;
5
+ 'secure_url'?: string;
6
+ 'type'?: string;
7
+ 'url'?: string;
8
+ 'width'?: number;
9
+ }
10
+ //# sourceMappingURL=OpenGraphStructured.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"OpenGraphStructured.d.ts","sourceRoot":"","sources":["../../../../src/models/OpenGraph/OpenGraphStructured.ts"],"names":[],"mappings":"AAAA,MAAM,WAAW,mBAAmB;IAClC,EAAE,CAAC,EAAE,MAAM,CAAA;IACX,KAAK,CAAC,EAAE,MAAM,CAAA;IACd,QAAQ,CAAC,EAAE,MAAM,CAAA;IACjB,YAAY,CAAC,EAAE,MAAM,CAAA;IACrB,MAAM,CAAC,EAAE,MAAM,CAAA;IACf,KAAK,CAAC,EAAE,MAAM,CAAA;IACd,OAAO,CAAC,EAAE,MAAM,CAAA;CACjB"}
@@ -0,0 +1,3 @@
1
+ import type { OpenGraphStructured } from './OpenGraphStructured.ts';
2
+ export type OpenGraphStructuredProperty = string | OpenGraphStructured | (string | OpenGraphStructured)[];
3
+ //# sourceMappingURL=OpenGraphStructuredProperty.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"OpenGraphStructuredProperty.d.ts","sourceRoot":"","sources":["../../../../src/models/OpenGraph/OpenGraphStructuredProperty.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,0BAA0B,CAAA;AAEnE,MAAM,MAAM,2BAA2B,GAAG,MAAM,GAAG,mBAAmB,GAAG,CAAC,MAAM,GAAG,mBAAmB,CAAC,EAAE,CAAA"}
@@ -0,0 +1,4 @@
1
+ export * from './OpenGraphMeta.ts';
2
+ export * from './OpenGraphStructured.ts';
3
+ export * from './OpenGraphStructuredProperty.ts';
4
+ //# sourceMappingURL=index.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/models/OpenGraph/index.ts"],"names":[],"mappings":"AAAA,cAAc,oBAAoB,CAAA;AAClC,cAAc,0BAA0B,CAAA;AACxC,cAAc,kCAAkC,CAAA"}
@@ -0,0 +1,66 @@
1
+ import type { TwitterApp } from './TwitterApp.ts';
2
+ import type { TwitterPlayer } from './TwitterPlayer.ts';
3
+ /**
4
+ * https://developer.twitter.com/en/docs/twitter-for-websites/cards/overview/markup
5
+ */
6
+ export interface TwitterMeta {
7
+ app?: TwitterApp;
8
+ /**
9
+ * The card type. Used with all cards. Fallback: og:type.
10
+ * If an og:type, og:title and og:description exist in the markup but
11
+ * twitter:card is absent, then a summary card may be rendered.
12
+ */
13
+ card?: 'summary' | 'summary_large_image' | 'app' | 'player';
14
+ creator?: {
15
+ /**
16
+ * The @username of content creator. Used with summary_large_image cards
17
+ */
18
+ ''?: string;
19
+ /**
20
+ * Twitter user ID of content creator. Used with summary,
21
+ * summary_large_image cards
22
+ */
23
+ 'id'?: string;
24
+ };
25
+ /**
26
+ * Description of content (maximum 200 characters). Used with summary,
27
+ * summary_large_image, player cards. Fallback: og:description.
28
+ */
29
+ description?: string;
30
+ image?: {
31
+ /**
32
+ * URL of image to use in the card. Images must be less than 5MB in size.
33
+ * JPG, PNG, WEBP and GIF formats are supported. Only the first frame of
34
+ * an animated GIF will be used. SVG is not supported. Used with summary,
35
+ * summary_large_image, player cards. Fallback: og:image
36
+ */
37
+ ''?: string;
38
+ /**
39
+ * A text description of the image conveying the essential nature of
40
+ * an image to users who are visually impaired. Maximum 420
41
+ * characters. Used with summary, summary_large_image, player cards
42
+ */
43
+ 'alt'?: string;
44
+ };
45
+ player?: TwitterPlayer;
46
+ /**
47
+ * The @username of website. Either twitter:site or twitter:site:id is
48
+ * required. Used with summary, summary_large_image, app, player
49
+ * cards
50
+ */
51
+ site?: {
52
+ ''?: string;
53
+ /**
54
+ * Same as twitter:site, but the user’s Twitter ID. Either
55
+ * twitter:site or twitter:site:id is required. Used with
56
+ * summary, summary_large_image, player cards
57
+ */
58
+ 'id'?: string;
59
+ };
60
+ /**
61
+ * Title of content (max 70 characters). Used with summary,
62
+ * summary_large_image, player cards. Fallback: og:title.
63
+ */
64
+ title?: string;
65
+ }
66
+ //# sourceMappingURL=Twitter.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"Twitter.d.ts","sourceRoot":"","sources":["../../../../src/models/Twitter/Twitter.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,iBAAiB,CAAA;AACjD,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,oBAAoB,CAAA;AAEvD;;GAEG;AACH,MAAM,WAAW,WAAW;IAC1B,GAAG,CAAC,EAAE,UAAU,CAAA;IAChB;;;;OAIG;IACH,IAAI,CAAC,EAAE,SAAS,GAAG,qBAAqB,GAAG,KAAK,GAAG,QAAQ,CAAA;IAE3D,OAAO,CAAC,EAAE;QACR;;WAEG;QACH,EAAE,CAAC,EAAE,MAAM,CAAA;QACX;;;WAGG;QACH,IAAI,CAAC,EAAE,MAAM,CAAA;KACd,CAAA;IACD;;;OAGG;IACH,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB,KAAK,CAAC,EAAE;QACN;;;;;WAKG;QACH,EAAE,CAAC,EAAE,MAAM,CAAA;QACX;;;;WAIG;QACH,KAAK,CAAC,EAAE,MAAM,CAAA;KACf,CAAA;IACD,MAAM,CAAC,EAAE,aAAa,CAAA;IACtB;;;;OAIG;IACH,IAAI,CAAC,EAAE;QACL,EAAE,CAAC,EAAE,MAAM,CAAA;QACX;;;;WAIG;QACH,IAAI,CAAC,EAAE,MAAM,CAAA;KACd,CAAA;IACD;;;OAGG;IACH,KAAK,CAAC,EAAE,MAAM,CAAA;CACf"}
@@ -0,0 +1,18 @@
1
+ export interface TwitterApp {
2
+ id?: {
3
+ googleplay?: string;
4
+ ipad?: string;
5
+ iphone?: string;
6
+ };
7
+ name?: {
8
+ googleplay?: string;
9
+ ipad?: string;
10
+ iphone?: string;
11
+ };
12
+ url?: {
13
+ googleplay?: string;
14
+ ipad?: string;
15
+ iphone?: string;
16
+ };
17
+ }
18
+ //# sourceMappingURL=TwitterApp.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"TwitterApp.d.ts","sourceRoot":"","sources":["../../../../src/models/Twitter/TwitterApp.ts"],"names":[],"mappings":"AAAA,MAAM,WAAW,UAAU;IACzB,EAAE,CAAC,EAAE;QACH,UAAU,CAAC,EAAE,MAAM,CAAA;QACnB,IAAI,CAAC,EAAE,MAAM,CAAA;QACb,MAAM,CAAC,EAAE,MAAM,CAAA;KAChB,CAAA;IACD,IAAI,CAAC,EAAE;QACL,UAAU,CAAC,EAAE,MAAM,CAAA;QACnB,IAAI,CAAC,EAAE,MAAM,CAAA;QACb,MAAM,CAAC,EAAE,MAAM,CAAA;KAChB,CAAA;IACD,GAAG,CAAC,EAAE;QACJ,UAAU,CAAC,EAAE,MAAM,CAAA;QACnB,IAAI,CAAC,EAAE,MAAM,CAAA;QACb,MAAM,CAAC,EAAE,MAAM,CAAA;KAChB,CAAA;CACF"}
@@ -0,0 +1,24 @@
1
+ /**
2
+ * https://developer.twitter.com/en/docs/twitter-for-websites/cards/overview/player-card
3
+ */
4
+ export interface TwitterPlayer {
5
+ /**
6
+ * HTTPS URL to iFrame player. This must be a HTTPS URL which does not
7
+ * generate active mixed content warnings in a web browser. The audio or
8
+ * video player must not require plugins such as Adobe Flash.
9
+ */
10
+ '': string;
11
+ /**
12
+ * Height of iframe in pixels. Used with player card
13
+ */
14
+ 'height'?: number;
15
+ /**
16
+ * URL to raw video or audio stream. Used with player card
17
+ */
18
+ 'stream'?: string;
19
+ /**
20
+ * Width of iframe in pixels. Used with player card
21
+ */
22
+ 'width'?: number;
23
+ }
24
+ //# sourceMappingURL=TwitterPlayer.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"TwitterPlayer.d.ts","sourceRoot":"","sources":["../../../../src/models/Twitter/TwitterPlayer.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,MAAM,WAAW,aAAa;IAC5B;;;;OAIG;IACH,EAAE,EAAE,MAAM,CAAA;IACV;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAA;IACjB;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAA;IACjB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAA;CACjB"}
@@ -0,0 +1,4 @@
1
+ export * from './Twitter.ts';
2
+ export * from './TwitterApp.ts';
3
+ export * from './TwitterPlayer.ts';
4
+ //# sourceMappingURL=index.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/models/Twitter/index.ts"],"names":[],"mappings":"AAAA,cAAc,cAAc,CAAA;AAC5B,cAAc,iBAAiB,CAAA;AAC/B,cAAc,oBAAoB,CAAA"}
@@ -0,0 +1,4 @@
1
+ export * from './Meta.ts';
2
+ export * from './OpenGraph/index.ts';
3
+ export * from './Twitter/index.ts';
4
+ //# sourceMappingURL=index.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/models/index.ts"],"names":[],"mappings":"AAAA,cAAc,WAAW,CAAA;AACzB,cAAc,sBAAsB,CAAA;AACpC,cAAc,oBAAoB,CAAA"}
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@xylabs/sdk-meta",
3
- "version": "4.13.13",
3
+ "version": "4.13.15",
4
4
  "description": "Base functionality used throughout XYO TypeScript/JavaScript libraries",
5
5
  "keywords": [
6
6
  "meta",
@@ -31,13 +31,13 @@
31
31
  "module": "dist/neutral/index.mjs",
32
32
  "types": "dist/neutral/index.d.ts",
33
33
  "dependencies": {
34
- "@xylabs/typeof": "^4.13.13",
34
+ "@xylabs/typeof": "^4.13.15",
35
35
  "cheerio": "^1.1.0"
36
36
  },
37
37
  "devDependencies": {
38
38
  "@types/node": "^24.0.13",
39
- "@xylabs/ts-scripts-yarn3": "^7.0.0-rc.9",
40
- "@xylabs/tsconfig": "^7.0.0-rc.9",
39
+ "@xylabs/ts-scripts-yarn3": "^7.0.0-rc.20",
40
+ "@xylabs/tsconfig": "^7.0.0-rc.20",
41
41
  "typescript": "^5.8.3",
42
42
  "vitest": "^3.2.4"
43
43
  },