@stonecrop/graphql-client 0.11.0 → 0.11.2

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 (42) hide show
  1. package/README.md +35 -130
  2. package/dist/client.js +38 -93
  3. package/dist/graphql-client.d.ts +28 -114
  4. package/dist/graphql-client.js +66 -7467
  5. package/dist/graphql-client.js.map +1 -1
  6. package/dist/index.js +0 -61
  7. package/dist/src/client.d.ts +24 -11
  8. package/dist/src/client.d.ts.map +1 -1
  9. package/dist/src/index.d.ts +2 -18
  10. package/dist/src/index.d.ts.map +1 -1
  11. package/dist/src/types/index.d.ts +7 -38
  12. package/dist/src/types/index.d.ts.map +1 -1
  13. package/dist/types/index.js +1 -1
  14. package/package.json +3 -5
  15. package/src/client.ts +42 -123
  16. package/src/index.ts +3 -70
  17. package/src/types/index.ts +6 -39
  18. package/dist/gql/schema.js +0 -53
  19. package/dist/graphql-client.umd.cjs +0 -199
  20. package/dist/graphql-client.umd.cjs.map +0 -1
  21. package/dist/queries.js +0 -19
  22. package/dist/query.js +0 -231
  23. package/dist/src/client.js +0 -221
  24. package/dist/src/gql/schema.d.ts +0 -7
  25. package/dist/src/gql/schema.d.ts.map +0 -1
  26. package/dist/src/gql/schema.js +0 -53
  27. package/dist/src/index.js +0 -61
  28. package/dist/src/queries.d.ts +0 -9
  29. package/dist/src/queries.d.ts.map +0 -1
  30. package/dist/src/queries.js +0 -19
  31. package/dist/src/query.d.ts +0 -35
  32. package/dist/src/query.d.ts.map +0 -1
  33. package/dist/src/stonecrop-client.d.ts +0 -87
  34. package/dist/src/stonecrop-client.d.ts.map +0 -1
  35. package/dist/src/tsdoc-metadata.json +0 -11
  36. package/dist/src/types/index.js +0 -4
  37. package/dist/stonecrop-client.js +0 -191
  38. package/src/gql/index.d.ts +0 -6
  39. package/src/gql/schema.gql +0 -45
  40. package/src/gql/schema.ts +0 -55
  41. package/src/queries.ts +0 -21
  42. package/src/query.ts +0 -303
@@ -1,87 +0,0 @@
1
- import type { DoctypeMeta as DoctypeMetaType } from '@stonecrop/schema';
2
- /**
3
- * Route context for identifying what doctype/record we're working with
4
- * @public
5
- */
6
- export interface RouteContext {
7
- /** Doctype name (e.g., 'Task', 'Customer') */
8
- doctype: string;
9
- /** Optional record ID for viewing/editing a specific record */
10
- recordId?: string;
11
- /** Additional context properties */
12
- [key: string]: unknown;
13
- }
14
- /**
15
- * Options for creating a Stonecrop client
16
- * @public
17
- */
18
- export interface StonecropClientOptions {
19
- /** GraphQL endpoint URL */
20
- endpoint: string;
21
- /** Additional HTTP headers to include in requests */
22
- headers?: Record<string, string>;
23
- }
24
- /**
25
- * Client for interacting with Stonecrop GraphQL API
26
- * @public
27
- */
28
- export declare class StonecropClient {
29
- private endpoint;
30
- private headers;
31
- private metaCache;
32
- constructor(options: StonecropClientOptions);
33
- /**
34
- * Execute a GraphQL query
35
- * @param query - GraphQL query string
36
- * @param variables - Query variables
37
- */
38
- query<T = unknown>(query: string, variables?: Record<string, unknown>): Promise<T>;
39
- /**
40
- * Execute a GraphQL mutation
41
- * @param mutation - GraphQL mutation string
42
- * @param variables - Mutation variables
43
- */
44
- mutate<T = unknown>(mutation: string, variables?: Record<string, unknown>): Promise<T>;
45
- /**
46
- * Get doctype metadata
47
- * @param context - Route context containing doctype name
48
- */
49
- getMeta(context: RouteContext): Promise<DoctypeMetaType | null>;
50
- /**
51
- * Get all doctype metadata
52
- */
53
- getAllMeta(): Promise<DoctypeMetaType[]>;
54
- /**
55
- * Get a single record by ID
56
- * @param doctype - Doctype metadata
57
- * @param recordId - Record ID to fetch
58
- */
59
- getRecord(doctype: DoctypeMetaType, recordId: string): Promise<Record<string, unknown> | null>;
60
- /**
61
- * Get multiple records with optional filtering and pagination
62
- * @param doctype - Doctype metadata
63
- * @param options - Query options (filters, orderBy, limit, offset)
64
- */
65
- getRecords(doctype: DoctypeMetaType, options?: {
66
- filters?: Record<string, unknown>;
67
- orderBy?: string;
68
- limit?: number;
69
- offset?: number;
70
- }): Promise<Record<string, unknown>[]>;
71
- /**
72
- * Execute a doctype action
73
- * @param doctype - Doctype metadata
74
- * @param action - Action name to execute
75
- * @param args - Action arguments
76
- */
77
- runAction(doctype: DoctypeMetaType, action: string, args?: unknown[]): Promise<{
78
- success: boolean;
79
- data: unknown;
80
- error: string | null;
81
- }>;
82
- /**
83
- * Clear the cached doctype metadata
84
- */
85
- clearMetaCache(): void;
86
- }
87
- //# sourceMappingURL=stonecrop-client.d.ts.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"stonecrop-client.d.ts","sourceRoot":"","sources":["../../src/stonecrop-client.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,WAAW,IAAI,eAAe,EAAE,MAAM,mBAAmB,CAAA;AAEvE;;;GAGG;AACH,MAAM,WAAW,YAAY;IAC5B,8CAA8C;IAC9C,OAAO,EAAE,MAAM,CAAA;IACf,+DAA+D;IAC/D,QAAQ,CAAC,EAAE,MAAM,CAAA;IACjB,oCAAoC;IACpC,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;CACtB;AAED;;;GAGG;AACH,MAAM,WAAW,sBAAsB;IACtC,2BAA2B;IAC3B,QAAQ,EAAE,MAAM,CAAA;IAChB,qDAAqD;IACrD,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAA;CAChC;AAED;;;GAGG;AACH,qBAAa,eAAe;IAC3B,OAAO,CAAC,QAAQ,CAAQ;IACxB,OAAO,CAAC,OAAO,CAAwB;IACvC,OAAO,CAAC,SAAS,CAA0C;gBAE/C,OAAO,EAAE,sBAAsB;IAQ3C;;;;OAIG;IACG,KAAK,CAAC,CAAC,GAAG,OAAO,EAAE,KAAK,EAAE,MAAM,EAAE,SAAS,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,OAAO,CAAC,CAAC,CAAC;IAmBxF;;;;OAIG;IACG,MAAM,CAAC,CAAC,GAAG,OAAO,EAAE,QAAQ,EAAE,MAAM,EAAE,SAAS,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,OAAO,CAAC,CAAC,CAAC;IAI5F;;;OAGG;IACG,OAAO,CAAC,OAAO,EAAE,YAAY,GAAG,OAAO,CAAC,eAAe,GAAG,IAAI,CAAC;IA0CrE;;OAEG;IACG,UAAU,IAAI,OAAO,CAAC,eAAe,EAAE,CAAC;IAsC9C;;;;OAIG;IACG,SAAS,CAAC,OAAO,EAAE,eAAe,EAAE,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,IAAI,CAAC;IAiBpG;;;;OAIG;IACG,UAAU,CACf,OAAO,EAAE,eAAe,EACxB,OAAO,CAAC,EAAE;QACT,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;QACjC,OAAO,CAAC,EAAE,MAAM,CAAA;QAChB,KAAK,CAAC,EAAE,MAAM,CAAA;QACd,MAAM,CAAC,EAAE,MAAM,CAAA;KACf,GACC,OAAO,CAAC,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EAAE,CAAC;IAiCrC;;;;;OAKG;IACG,SAAS,CACd,OAAO,EAAE,eAAe,EACxB,MAAM,EAAE,MAAM,EACd,IAAI,CAAC,EAAE,OAAO,EAAE,GACd,OAAO,CAAC;QAAE,OAAO,EAAE,OAAO,CAAC;QAAC,IAAI,EAAE,OAAO,CAAC;QAAC,KAAK,EAAE,MAAM,GAAG,IAAI,CAAA;KAAE,CAAC;IAuBrE;;OAEG;IACH,cAAc,IAAI,IAAI;CAGtB"}
@@ -1,11 +0,0 @@
1
- // This file is read by tools that parse documentation comments conforming to the TSDoc standard.
2
- // It should be published with your NPM package. It should not be tracked by Git.
3
- {
4
- "tsdocVersion": "0.12",
5
- "toolPackages": [
6
- {
7
- "packageName": "@microsoft/api-extractor",
8
- "packageVersion": "7.57.0"
9
- }
10
- ]
11
- }
@@ -1,4 +0,0 @@
1
- /**
2
- * @file This file contains all the types that are used in the application.
3
- * @public
4
- */
@@ -1,191 +0,0 @@
1
- /**
2
- * Client for interacting with Stonecrop GraphQL API
3
- * @public
4
- */
5
- export class StonecropClient {
6
- endpoint;
7
- headers;
8
- metaCache = new Map();
9
- constructor(options) {
10
- this.endpoint = options.endpoint;
11
- this.headers = {
12
- 'Content-Type': 'application/json',
13
- ...options.headers,
14
- };
15
- }
16
- /**
17
- * Execute a GraphQL query
18
- * @param query - GraphQL query string
19
- * @param variables - Query variables
20
- */
21
- async query(query, variables) {
22
- const response = await fetch(this.endpoint, {
23
- method: 'POST',
24
- headers: this.headers,
25
- body: JSON.stringify({ query, variables }),
26
- });
27
- const json = (await response.json());
28
- if (json.errors?.length) {
29
- throw new Error(json.errors[0].message);
30
- }
31
- return json.data;
32
- }
33
- /**
34
- * Execute a GraphQL mutation
35
- * @param mutation - GraphQL mutation string
36
- * @param variables - Mutation variables
37
- */
38
- async mutate(mutation, variables) {
39
- return this.query(mutation, variables);
40
- }
41
- /**
42
- * Get doctype metadata
43
- * @param context - Route context containing doctype name
44
- */
45
- async getMeta(context) {
46
- const cached = this.metaCache.get(context.doctype);
47
- if (cached)
48
- return cached;
49
- const result = await this.query(`
50
- query GetMeta($doctype: String!) {
51
- stonecropMeta(doctype: $doctype) {
52
- name
53
- slug
54
- tableName
55
- fields {
56
- fieldname
57
- fieldtype
58
- component
59
- label
60
- required
61
- readOnly
62
- options
63
- precision
64
- scale
65
- }
66
- workflow {
67
- states
68
- actions
69
- }
70
- inherits
71
- listDoctype
72
- parentDoctype
73
- }
74
- }
75
- `, { doctype: context.doctype });
76
- if (result.stonecropMeta) {
77
- this.metaCache.set(context.doctype, result.stonecropMeta);
78
- }
79
- return result.stonecropMeta;
80
- }
81
- /**
82
- * Get all doctype metadata
83
- */
84
- async getAllMeta() {
85
- const result = await this.query(`
86
- query GetAllMeta {
87
- stonecropAllMeta {
88
- name
89
- slug
90
- tableName
91
- fields {
92
- fieldname
93
- fieldtype
94
- component
95
- label
96
- required
97
- readOnly
98
- options
99
- precision
100
- scale
101
- }
102
- workflow {
103
- states
104
- actions
105
- }
106
- inherits
107
- listDoctype
108
- parentDoctype
109
- }
110
- }
111
- `);
112
- for (const meta of result.stonecropAllMeta) {
113
- this.metaCache.set(meta.name, meta);
114
- }
115
- return result.stonecropAllMeta;
116
- }
117
- /**
118
- * Get a single record by ID
119
- * @param doctype - Doctype metadata
120
- * @param recordId - Record ID to fetch
121
- */
122
- async getRecord(doctype, recordId) {
123
- const result = await this.query(`
124
- query GetRecord($doctype: String!, $id: String!) {
125
- stonecropRecord(doctype: $doctype, id: $id) {
126
- data
127
- }
128
- }
129
- `, { doctype: doctype.name, id: recordId });
130
- return result.stonecropRecord.data;
131
- }
132
- /**
133
- * Get multiple records with optional filtering and pagination
134
- * @param doctype - Doctype metadata
135
- * @param options - Query options (filters, orderBy, limit, offset)
136
- */
137
- async getRecords(doctype, options) {
138
- const result = await this.query(`
139
- query GetRecords(
140
- $doctype: String!
141
- $filters: JSON
142
- $orderBy: String
143
- $limit: Int
144
- $offset: Int
145
- ) {
146
- stonecropRecords(
147
- doctype: $doctype
148
- filters: $filters
149
- orderBy: $orderBy
150
- limit: $limit
151
- offset: $offset
152
- ) {
153
- data
154
- count
155
- }
156
- }
157
- `, {
158
- doctype: doctype.name,
159
- ...options,
160
- });
161
- return result.stonecropRecords.data;
162
- }
163
- /**
164
- * Execute a doctype action
165
- * @param doctype - Doctype metadata
166
- * @param action - Action name to execute
167
- * @param args - Action arguments
168
- */
169
- async runAction(doctype, action, args) {
170
- const result = await this.query(`
171
- mutation RunAction($doctype: String!, $action: String!, $args: JSON) {
172
- stonecropAction(doctype: $doctype, action: $action, args: $args) {
173
- success
174
- data
175
- error
176
- }
177
- }
178
- `, {
179
- doctype: doctype.name,
180
- action,
181
- args,
182
- });
183
- return result.stonecropAction;
184
- }
185
- /**
186
- * Clear the cached doctype metadata
187
- */
188
- clearMetaCache() {
189
- this.metaCache.clear();
190
- }
191
- }
@@ -1,6 +0,0 @@
1
- declare module '*.gql' {
2
- import { DocumentNode } from 'graphql'
3
- const Schema: DocumentNode
4
-
5
- export = Schema
6
- }
@@ -1,45 +0,0 @@
1
- type Doctype {
2
- id: ID!
3
- name: String!
4
- workflow: DoctypeWorkflow!
5
- schema: [DoctypeField!]!
6
- actions: [DoctypeActions!]!
7
- }
8
-
9
- type DoctypeField {
10
- id: ID!
11
- label: String!
12
- fieldtype: String
13
- component: String
14
- required: Boolean
15
- readonly: Boolean
16
- }
17
-
18
- type DoctypeWorkflow {
19
- name: String!
20
- machine: StateMachine!
21
- }
22
-
23
- type StateMachine {
24
- id: ID!
25
- }
26
-
27
- type DoctypeAction {
28
- eventName: String!
29
- callback: String
30
- }
31
-
32
- type Query {
33
- getMeta(doctype: String!): Doctype # ∪ error
34
- getRecords(doctype: String!, filters: Filters): [Record] # ∪ error
35
- getRecord(doctype: String!, id: ID!): Record # ∪ error
36
- }
37
-
38
- type Mutation {
39
- runAction(doctype: String!, id: [ID!]!, functionName: String!): [Record!]! # ∪ error
40
- }
41
-
42
- schema {
43
- query: Query
44
- mutation: Mutation
45
- }
package/src/gql/schema.ts DELETED
@@ -1,55 +0,0 @@
1
- import { gql } from 'graphql-request'
2
-
3
- /**
4
- * This is the schema for the GraphQL API.
5
- * @public
6
- */
7
- const typeDefs = gql`
8
- type Doctype {
9
- id: ID!
10
- name: String!
11
- workflow: String!
12
- schema: String!
13
- actions: String!
14
- }
15
-
16
- type DoctypeField {
17
- id: ID!
18
- label: String!
19
- fieldtype: String
20
- component: String
21
- required: Boolean
22
- readonly: Boolean
23
- }
24
-
25
- type DoctypeWorkflow {
26
- name: String!
27
- machine: StateMachine!
28
- }
29
-
30
- type StateMachine {
31
- id: ID!
32
- }
33
-
34
- type DoctypeAction {
35
- eventName: String!
36
- callback: String
37
- }
38
-
39
- type Query {
40
- getMeta(doctype: String!): Doctype # ∪ error
41
- getRecords(doctype: String!, filters: [String]): [String] # ∪ error
42
- getRecord(doctype: String!, id: ID!): String # ∪ error
43
- }
44
-
45
- type Mutation {
46
- runAction(doctype: String!, id: [ID!]!, functionName: String!): [String!]! # ∪ error
47
- }
48
-
49
- schema {
50
- query: Query
51
- mutation: Mutation
52
- }
53
- `
54
-
55
- export default typeDefs
package/src/queries.ts DELETED
@@ -1,21 +0,0 @@
1
- import { gql } from 'graphql-request'
2
-
3
- /**
4
- * Queries for the GraphQL API.
5
- * @public
6
- */
7
- const queries = {
8
- getMeta: gql`
9
- query getDoctype($doctype: String!) {
10
- getMeta(doctype: $doctype) {
11
- id
12
- name
13
- workflow
14
- schema
15
- actions
16
- }
17
- }
18
- `,
19
- }
20
-
21
- export { queries }