fms-odata-js 0.3.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.
- package/CHANGELOG.md +160 -0
- package/LICENSE +22 -0
- package/README.md +381 -0
- package/dist/batch.d.ts +154 -0
- package/dist/batch.d.ts.map +1 -0
- package/dist/client.d.ts +160 -0
- package/dist/client.d.ts.map +1 -0
- package/dist/containers.d.ts +190 -0
- package/dist/containers.d.ts.map +1 -0
- package/dist/entity.d.ts +149 -0
- package/dist/entity.d.ts.map +1 -0
- package/dist/errors.d.ts +69 -0
- package/dist/errors.d.ts.map +1 -0
- package/dist/fms-odata.esm.js +2201 -0
- package/dist/fms-odata.esm.min.js +6 -0
- package/dist/fms-odata.iife.min.js +6 -0
- package/dist/http.d.ts +51 -0
- package/dist/http.d.ts.map +1 -0
- package/dist/index.d.ts +31 -0
- package/dist/index.d.ts.map +1 -0
- package/dist/metadata.d.ts +85 -0
- package/dist/metadata.d.ts.map +1 -0
- package/dist/query.d.ts +198 -0
- package/dist/query.d.ts.map +1 -0
- package/dist/scripts.d.ts +114 -0
- package/dist/scripts.d.ts.map +1 -0
- package/dist/types.d.ts +26 -0
- package/dist/types.d.ts.map +1 -0
- package/dist/url.d.ts +49 -0
- package/dist/url.d.ts.map +1 -0
- package/package.json +61 -0
- package/src/batch.ts +477 -0
- package/src/client.ts +268 -0
- package/src/containers.ts +457 -0
- package/src/entity.ts +334 -0
- package/src/errors.ts +134 -0
- package/src/http.ts +190 -0
- package/src/index.ts +81 -0
- package/src/metadata.ts +354 -0
- package/src/query.ts +442 -0
- package/src/scripts.ts +279 -0
- package/src/types.ts +30 -0
- package/src/url.ts +98 -0
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"entity.d.ts","sourceRoot":"","sources":["../src/entity.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,aAAa,CAAA;AAC3C,OAAO,EAEL,YAAY,EACZ,KAAK,kBAAkB,EACxB,MAAM,iBAAiB,CAAA;AAExB,OAAO,EAAqB,KAAK,aAAa,EAAE,KAAK,YAAY,EAAE,MAAM,cAAc,CAAA;AACvF,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,YAAY,CAAA;AAChD,OAAO,EAGL,KAAK,YAAY,EAClB,MAAM,UAAU,CAAA;AAEjB,sDAAsD;AACtD,MAAM,WAAW,kBAAmB,SAAQ,cAAc;IACxD;;;OAGG;IACH,OAAO,CAAC,EAAE,MAAM,CAAA;IAChB;;;;OAIG;IACH,oBAAoB,CAAC,EAAE,OAAO,CAAA;CAC/B;AAkBD;;;;GAIG;AACH,qBAAa,SAAS,CAAC,CAAC,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC;IAChD,QAAQ,CAAC,SAAS,EAAE,MAAM,CAAA;IAC1B,QAAQ,CAAC,GAAG,EAAE,YAAY,CAAA;IAE1B,gBAAgB,CAAC,QAAQ,CAAC,OAAO,EAAE,QAAQ,CAAA;gBAE/B,MAAM,EAAE,QAAQ,EAAE,SAAS,EAAE,MAAM,EAAE,GAAG,EAAE,YAAY;IAMlE,oCAAoC;IACpC,KAAK,IAAI,MAAM;IAIf,qDAAqD;IAC/C,GAAG,CAAC,IAAI,GAAE,cAAmB,GAAG,OAAO,CAAC,CAAC,CAAC;IAShD;;;;;;;OAOG;IACG,UAAU,CAAC,CAAC,GAAG,OAAO,EAAE,SAAS,EAAE,MAAM,EAAE,IAAI,GAAE,cAAmB,GAAG,OAAO,CAAC,CAAC,CAAC;IAUvF;;;;OAIG;IACG,KAAK,CACT,IAAI,EAAE,OAAO,CAAC,CAAC,CAAC,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EAC1C,IAAI,GAAE,kBAAuB,GAC5B,OAAO,CAAC,CAAC,GAAG,SAAS,CAAC;IAiBzB,kFAAkF;IAC5E,MAAM,CAAC,IAAI,GAAE,kBAAuB,GAAG,OAAO,CAAC,IAAI,CAAC;IAY1D;;;OAGG;IACG,MAAM,CAAC,IAAI,EAAE,MAAM,EAAE,IAAI,GAAE,aAAkB,GAAG,OAAO,CAAC,YAAY,CAAC;IAI3E;;;OAGG;IACH,SAAS,CAAC,SAAS,EAAE,MAAM,GAAG,YAAY;IAI1C;;;;;;;;;;;;;;;;;;OAkBG;IACG,eAAe,CACnB,UAAU,EAAE,MAAM,CAAC,MAAM,EAAE,kBAAkB,CAAC,EAC9C,aAAa,GAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAM,EAC3C,IAAI,GAAE,kBAAuB,GAC5B,OAAO,CAAC,IAAI,CAAC;IAqBhB;;;;;;;;;;;;;OAaG;IACG,OAAO,CAAC,WAAW,EAAE,MAAM,EAAE,IAAI,GAAE,cAAmB,GAAG,OAAO,CAAC,aAAa,EAAE,CAAC;IAkBvF;;;;;;;;;;;OAWG;IACG,MAAM,CAAC,WAAW,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,GAAG,MAAM,EAAE,IAAI,GAAE,kBAAuB,GAAG,OAAO,CAAC,IAAI,CAAC;IAe5G;;;;;;;;;OASG;IACG,MAAM,CAAC,WAAW,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,GAAG,MAAM,EAAE,IAAI,GAAE,kBAAuB,GAAG,OAAO,CAAC,IAAI,CAAC;IAe5G;;;;;;;;;;;;;;OAcG;IACG,SAAS,CAAC,WAAW,EAAE,MAAM,EAAE,UAAU,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,IAAI,GAAE,kBAAuB,GAAG,OAAO,CAAC,IAAI,CAAC;IAkBhH,mEAAmE;IACnE,OAAO,CAAC,MAAM;CAQf;AAED,qDAAqD;AACrD,MAAM,WAAW,aAAa;IAC5B,WAAW,EAAE,MAAM,CAAA;CACpB"}
|
package/dist/errors.d.ts
ADDED
|
@@ -0,0 +1,69 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Normalized error thrown by all fms-odata-js operations.
|
|
3
|
+
*
|
|
4
|
+
* The error class shape is aligned with `@fms-odata/spec-ts` (the canonical
|
|
5
|
+
* spec package). fms-odata-js keeps its own class identity for backward
|
|
6
|
+
* compatibility with existing `instanceof` checks in user code.
|
|
7
|
+
*
|
|
8
|
+
* @see https://github.com/fsans/fms-odata-spec/blob/main/docs/13-quirks.md
|
|
9
|
+
*/
|
|
10
|
+
export declare class FMSODataError extends Error {
|
|
11
|
+
readonly status: number;
|
|
12
|
+
readonly code: string | undefined;
|
|
13
|
+
readonly odataError: unknown;
|
|
14
|
+
readonly request: {
|
|
15
|
+
url: string;
|
|
16
|
+
method: string;
|
|
17
|
+
} | undefined;
|
|
18
|
+
constructor(message: string, init: {
|
|
19
|
+
status: number;
|
|
20
|
+
code?: string;
|
|
21
|
+
odataError?: unknown;
|
|
22
|
+
request?: {
|
|
23
|
+
url: string;
|
|
24
|
+
method: string;
|
|
25
|
+
};
|
|
26
|
+
});
|
|
27
|
+
}
|
|
28
|
+
/**
|
|
29
|
+
* Parse an error Response body into a `FMSODataError`. Handles both stock OData
|
|
30
|
+
* JSON envelopes (`{ error: { code, message } }`) and FileMaker's XML envelope
|
|
31
|
+
* (`<m:error><m:code>212</m:code><m:message>...</m:message></m:error>`).
|
|
32
|
+
*
|
|
33
|
+
* @internal
|
|
34
|
+
*/
|
|
35
|
+
export declare function parseErrorResponse(res: Response, request: {
|
|
36
|
+
url: string;
|
|
37
|
+
method: string;
|
|
38
|
+
}): Promise<FMSODataError>;
|
|
39
|
+
/**
|
|
40
|
+
* Thrown when a FileMaker script invocation completes with a non-zero
|
|
41
|
+
* `scriptError`. The HTTP request itself succeeded (the server returned 2xx),
|
|
42
|
+
* but the script reported an error via the FMS result envelope.
|
|
43
|
+
*
|
|
44
|
+
* Subclass of `FMSODataError` so existing `instanceof FMSODataError` checks and
|
|
45
|
+
* error-handling code keep working.
|
|
46
|
+
*/
|
|
47
|
+
export declare class FMScriptError extends FMSODataError {
|
|
48
|
+
/** FileMaker script error code as a string (e.g. `"101"`). */
|
|
49
|
+
readonly scriptError: string;
|
|
50
|
+
/** Raw `scriptResult` value returned by the script, if any. */
|
|
51
|
+
readonly scriptResult: string | undefined;
|
|
52
|
+
constructor(message: string, init: {
|
|
53
|
+
status: number;
|
|
54
|
+
scriptError: string;
|
|
55
|
+
scriptResult?: string;
|
|
56
|
+
odataError?: unknown;
|
|
57
|
+
request?: {
|
|
58
|
+
url: string;
|
|
59
|
+
method: string;
|
|
60
|
+
};
|
|
61
|
+
});
|
|
62
|
+
}
|
|
63
|
+
/** OData standard error response body shape (from spec). */
|
|
64
|
+
export type { ODataErrorBody } from '@fms-odata/spec-ts';
|
|
65
|
+
/** Check if an error is a FileMaker OData error. */
|
|
66
|
+
export declare function isFMSODataError(err: unknown): err is FMSODataError;
|
|
67
|
+
/** Check if an error is a FileMaker script error. */
|
|
68
|
+
export declare function isFMScriptError(err: unknown): err is FMScriptError;
|
|
69
|
+
//# sourceMappingURL=errors.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"errors.d.ts","sourceRoot":"","sources":["../src/errors.ts"],"names":[],"mappings":"AAAA;;;;;;;;GAQG;AACH,qBAAa,aAAc,SAAQ,KAAK;IACtC,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAA;IACvB,QAAQ,CAAC,IAAI,EAAE,MAAM,GAAG,SAAS,CAAA;IACjC,QAAQ,CAAC,UAAU,EAAE,OAAO,CAAA;IAC5B,QAAQ,CAAC,OAAO,EAAE;QAAE,GAAG,EAAE,MAAM,CAAC;QAAC,MAAM,EAAE,MAAM,CAAA;KAAE,GAAG,SAAS,CAAA;gBAG3D,OAAO,EAAE,MAAM,EACf,IAAI,EAAE;QACJ,MAAM,EAAE,MAAM,CAAA;QACd,IAAI,CAAC,EAAE,MAAM,CAAA;QACb,UAAU,CAAC,EAAE,OAAO,CAAA;QACpB,OAAO,CAAC,EAAE;YAAE,GAAG,EAAE,MAAM,CAAC;YAAC,MAAM,EAAE,MAAM,CAAA;SAAE,CAAA;KAC1C;CASJ;AAED;;;;;;GAMG;AACH,wBAAsB,kBAAkB,CACtC,GAAG,EAAE,QAAQ,EACb,OAAO,EAAE;IAAE,GAAG,EAAE,MAAM,CAAC;IAAC,MAAM,EAAE,MAAM,CAAA;CAAE,GACvC,OAAO,CAAC,aAAa,CAAC,CAqCxB;AAED;;;;;;;GAOG;AACH,qBAAa,aAAc,SAAQ,aAAa;IAC9C,8DAA8D;IAC9D,QAAQ,CAAC,WAAW,EAAE,MAAM,CAAA;IAC5B,+DAA+D;IAC/D,QAAQ,CAAC,YAAY,EAAE,MAAM,GAAG,SAAS,CAAA;gBAGvC,OAAO,EAAE,MAAM,EACf,IAAI,EAAE;QACJ,MAAM,EAAE,MAAM,CAAA;QACd,WAAW,EAAE,MAAM,CAAA;QACnB,YAAY,CAAC,EAAE,MAAM,CAAA;QACrB,UAAU,CAAC,EAAE,OAAO,CAAA;QACpB,OAAO,CAAC,EAAE;YAAE,GAAG,EAAE,MAAM,CAAC;YAAC,MAAM,EAAE,MAAM,CAAA;SAAE,CAAA;KAC1C;CAYJ;AAMD,4DAA4D;AAC5D,YAAY,EAAE,cAAc,EAAE,MAAM,oBAAoB,CAAA;AAExD,oDAAoD;AACpD,wBAAgB,eAAe,CAAC,GAAG,EAAE,OAAO,GAAG,GAAG,IAAI,aAAa,CAElE;AAED,qDAAqD;AACrD,wBAAgB,eAAe,CAAC,GAAG,EAAE,OAAO,GAAG,GAAG,IAAI,aAAa,CAElE"}
|