@inneropen/marvin-sdk 1.0.0

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 (12) hide show
  1. package/QUICKSTART.md +408 -0
  2. package/README.md +721 -0
  3. package/dist/index.cjs +859 -0
  4. package/dist/index.d.cts +430 -0
  5. package/dist/index.d.ts +430 -0
  6. package/dist/index.js +846 -0
  7. package/dist/types/index.cjs +18 -0
  8. package/dist/types/index.d.cts +120 -0
  9. package/dist/types/index.d.ts +120 -0
  10. package/dist/types/index.js +0 -0
  11. package/examples.md +961 -0
  12. package/package.json +73 -0
package/dist/types/index.cjs ADDED
@@ -0,0 +1,18 @@
1
+ "use strict";
2
+ var __defProp = Object.defineProperty;
3
+ var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
4
+ var __getOwnPropNames = Object.getOwnPropertyNames;
5
+ var __hasOwnProp = Object.prototype.hasOwnProperty;
6
+ var __copyProps = (to, from, except, desc) => {
7
+ if (from && typeof from === "object" || typeof from === "function") {
8
+ for (let key of __getOwnPropNames(from))
9
+ if (!__hasOwnProp.call(to, key) && key !== except)
10
+ __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
11
+ }
12
+ return to;
13
+ };
14
+ var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
15
+
16
+ // src/types/index.ts
17
+ var types_exports = {};
18
+ module.exports = __toCommonJS(types_exports);
package/dist/types/index.d.cts ADDED
@@ -0,0 +1,120 @@
1
+ /**
2
+ * Marvin Publishing Client Types
3
+ *
4
+ * TypeScript types for the Marvin publishing API responses.
5
+ */
6
+ interface MarvinSite {
7
+ id: string;
8
+ name: string;
9
+ slug: string;
10
+ title?: string;
11
+ tagline?: string;
12
+ description?: string;
13
+ canonicalUrl?: string;
14
+ logo?: string;
15
+ favicon?: string;
16
+ locale?: string;
17
+ timezone?: string;
18
+ metadata?: Record<string, unknown>;
19
+ }
20
+ interface MarvinEntryType {
21
+ id: string;
22
+ name: string;
23
+ slug: string;
24
+ icon?: string;
25
+ color?: string;
26
+ description?: string;
27
+ sortOrder: number;
28
+ isSystem: boolean;
29
+ }
30
+ interface MarvinAsset {
31
+ id: string;
32
+ name: string;
33
+ slug: string;
34
+ url: string;
35
+ mimeType: string;
36
+ fileSize?: number;
37
+ width?: number;
38
+ height?: number;
39
+ altText?: string;
40
+ description?: string;
41
+ focalPoint?: string;
42
+ metadata?: Record<string, unknown>;
43
+ createdAt: string;
44
+ updatedAt: string;
45
+ }
46
+ interface MarvinCollection {
47
+ id: string;
48
+ name: string;
49
+ slug: string;
50
+ description?: string;
51
+ icon?: string;
52
+ color?: string;
53
+ sortOrder: number;
54
+ isSmart: boolean;
55
+ smartRules?: Record<string, unknown>;
56
+ createdAt: string;
57
+ updatedAt: string;
58
+ }
59
+ interface MarvinResource {
60
+ id: string;
61
+ name: string;
62
+ slug: string;
63
+ resourceType?: string;
64
+ description?: string;
65
+ externalId?: string;
66
+ url?: string;
67
+ metadata?: Record<string, unknown>;
68
+ createdAt: string;
69
+ updatedAt: string;
70
+ }
71
+ interface MarvinEntry {
72
+ id: string;
73
+ title: string;
74
+ slug: string;
75
+ summary?: string;
76
+ description?: string;
77
+ contentMarkdown?: string;
78
+ metadata?: Record<string, unknown>;
79
+ status: string;
80
+ publishedAt?: string;
81
+ createdAt: string;
82
+ updatedAt: string;
83
+ entryTypeId: string;
84
+ entryType?: MarvinEntryType;
85
+ collections?: MarvinCollection[];
86
+ assets?: MarvinAsset[];
87
+ resources?: MarvinResource[];
88
+ }
89
+ interface MarvinPublishResponse<T> {
90
+ data: T;
91
+ meta?: {
92
+ total?: number;
93
+ page?: number;
94
+ limit?: number;
95
+ };
96
+ }
97
+ interface MarvinClientConfig {
98
+ apiUrl: string;
99
+ siteClientToken: string;
100
+ workspaceSlug: string;
101
+ }
102
+ interface GetEntriesOptions {
103
+ entryType?: string;
104
+ collection?: string;
105
+ limit?: number;
106
+ offset?: number;
107
+ status?: string;
108
+ }
109
+ interface GetAssetsOptions {
110
+ type?: string;
111
+ limit?: number;
112
+ offset?: number;
113
+ }
114
+ interface GetResourcesOptions {
115
+ resourceType?: string;
116
+ limit?: number;
117
+ offset?: number;
118
+ }
119
+
120
+ export type { GetAssetsOptions, GetEntriesOptions, GetResourcesOptions, MarvinAsset, MarvinClientConfig, MarvinCollection, MarvinEntry, MarvinEntryType, MarvinPublishResponse, MarvinResource, MarvinSite };
package/dist/types/index.d.ts ADDED
@@ -0,0 +1,120 @@
1
+ /**
2
+ * Marvin Publishing Client Types
3
+ *
4
+ * TypeScript types for the Marvin publishing API responses.
5
+ */
6
+ interface MarvinSite {
7
+ id: string;
8
+ name: string;
9
+ slug: string;
10
+ title?: string;
11
+ tagline?: string;
12
+ description?: string;
13
+ canonicalUrl?: string;
14
+ logo?: string;
15
+ favicon?: string;
16
+ locale?: string;
17
+ timezone?: string;
18
+ metadata?: Record<string, unknown>;
19
+ }
20
+ interface MarvinEntryType {
21
+ id: string;
22
+ name: string;
23
+ slug: string;
24
+ icon?: string;
25
+ color?: string;
26
+ description?: string;
27
+ sortOrder: number;
28
+ isSystem: boolean;
29
+ }
30
+ interface MarvinAsset {
31
+ id: string;
32
+ name: string;
33
+ slug: string;
34
+ url: string;
35
+ mimeType: string;
36
+ fileSize?: number;
37
+ width?: number;
38
+ height?: number;
39
+ altText?: string;
40
+ description?: string;
41
+ focalPoint?: string;
42
+ metadata?: Record<string, unknown>;
43
+ createdAt: string;
44
+ updatedAt: string;
45
+ }
46
+ interface MarvinCollection {
47
+ id: string;
48
+ name: string;
49
+ slug: string;
50
+ description?: string;
51
+ icon?: string;
52
+ color?: string;
53
+ sortOrder: number;
54
+ isSmart: boolean;
55
+ smartRules?: Record<string, unknown>;
56
+ createdAt: string;
57
+ updatedAt: string;
58
+ }
59
+ interface MarvinResource {
60
+ id: string;
61
+ name: string;
62
+ slug: string;
63
+ resourceType?: string;
64
+ description?: string;
65
+ externalId?: string;
66
+ url?: string;
67
+ metadata?: Record<string, unknown>;
68
+ createdAt: string;
69
+ updatedAt: string;
70
+ }
71
+ interface MarvinEntry {
72
+ id: string;
73
+ title: string;
74
+ slug: string;
75
+ summary?: string;
76
+ description?: string;
77
+ contentMarkdown?: string;
78
+ metadata?: Record<string, unknown>;
79
+ status: string;
80
+ publishedAt?: string;
81
+ createdAt: string;
82
+ updatedAt: string;
83
+ entryTypeId: string;
84
+ entryType?: MarvinEntryType;
85
+ collections?: MarvinCollection[];
86
+ assets?: MarvinAsset[];
87
+ resources?: MarvinResource[];
88
+ }
89
+ interface MarvinPublishResponse<T> {
90
+ data: T;
91
+ meta?: {
92
+ total?: number;
93
+ page?: number;
94
+ limit?: number;
95
+ };
96
+ }
97
+ interface MarvinClientConfig {
98
+ apiUrl: string;
99
+ siteClientToken: string;
100
+ workspaceSlug: string;
101
+ }
102
+ interface GetEntriesOptions {
103
+ entryType?: string;
104
+ collection?: string;
105
+ limit?: number;
106
+ offset?: number;
107
+ status?: string;
108
+ }
109
+ interface GetAssetsOptions {
110
+ type?: string;
111
+ limit?: number;
112
+ offset?: number;
113
+ }
114
+ interface GetResourcesOptions {
115
+ resourceType?: string;
116
+ limit?: number;
117
+ offset?: number;
118
+ }
119
+
120
+ export type { GetAssetsOptions, GetEntriesOptions, GetResourcesOptions, MarvinAsset, MarvinClientConfig, MarvinCollection, MarvinEntry, MarvinEntryType, MarvinPublishResponse, MarvinResource, MarvinSite };
package/dist/types/index.js ADDED
File without changes