@api-client/core 0.5.5 → 0.5.6
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/src/models/RevisionInfo.d.ts +2 -2
- package/build/src/runtime/store/FilesSdk.d.ts +3 -3
- package/build/src/runtime/store/FilesSdk.js +1 -1
- package/build/src/runtime/store/FilesSdk.js.map +1 -1
- package/package.json +2 -3
- package/src/models/RevisionInfo.ts +2 -2
- package/src/runtime/store/FilesSdk.ts +6 -6
- package/json8-patch.d.ts +0 -270
|
@@ -2,7 +2,7 @@ import { IModification } from './store/Modification.js';
|
|
|
2
2
|
export declare const Kind = "Core#Revision";
|
|
3
3
|
/**
|
|
4
4
|
* The definition of a patch revision.
|
|
5
|
-
* The revision is created with the
|
|
5
|
+
* The revision is created with the `@api-client/json` library.
|
|
6
6
|
*/
|
|
7
7
|
export interface IRevisionInfo {
|
|
8
8
|
/**
|
|
@@ -31,7 +31,7 @@ export interface IRevisionInfo {
|
|
|
31
31
|
*/
|
|
32
32
|
deleted?: boolean;
|
|
33
33
|
/**
|
|
34
|
-
* The
|
|
34
|
+
* The `@api-client/json` revisions object used to restore the previous state.
|
|
35
35
|
*/
|
|
36
36
|
patch: any[];
|
|
37
37
|
/**
|
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
import WebSocketNode from 'ws';
|
|
2
|
-
import {
|
|
2
|
+
import { Patch } from '@api-client/json';
|
|
3
3
|
import { SdkBase, ISdkRequestOptions } from './SdkBase.js';
|
|
4
4
|
import { IListOptions, IListResponse } from '../../models/Backend.js';
|
|
5
5
|
import { AccessOperation } from '../../models/store/Permission.js';
|
|
@@ -55,7 +55,7 @@ export declare class FilesSdk extends SdkBase {
|
|
|
55
55
|
* @param value The patch to apply.
|
|
56
56
|
* @param request Optional request options.
|
|
57
57
|
*/
|
|
58
|
-
patch(key: string, value: JsonPatch, media: false, request?: ISdkRequestOptions): Promise<JsonPatch>;
|
|
58
|
+
patch(key: string, value: Patch.JsonPatch, media: false, request?: ISdkRequestOptions): Promise<Patch.JsonPatch>;
|
|
59
59
|
/**
|
|
60
60
|
* Patches file's content in the store.
|
|
61
61
|
*
|
|
@@ -63,7 +63,7 @@ export declare class FilesSdk extends SdkBase {
|
|
|
63
63
|
* @param value The patch to apply.
|
|
64
64
|
* @param request Optional request options.
|
|
65
65
|
*/
|
|
66
|
-
patch(key: string, value: JsonPatch, media: true, request?: ISdkRequestOptions): Promise<JsonPatch>;
|
|
66
|
+
patch(key: string, value: Patch.JsonPatch, media: true, request?: ISdkRequestOptions): Promise<Patch.JsonPatch>;
|
|
67
67
|
/**
|
|
68
68
|
* Deletes the file in the store.
|
|
69
69
|
*
|
|
@@ -116,7 +116,7 @@ export class FilesSdk extends SdkBase {
|
|
|
116
116
|
* @param key The key of the file to patch
|
|
117
117
|
* @param value The JSON patch to be processed.
|
|
118
118
|
* @param request Optional request options.
|
|
119
|
-
* @returns The JSON patch to revert the change using the
|
|
119
|
+
* @returns The JSON patch to revert the change using the `@api-client/json` library
|
|
120
120
|
*/
|
|
121
121
|
async patch(key, value, media, request = {}) {
|
|
122
122
|
const token = request.token || this.sdk.token;
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"FilesSdk.js","sourceRoot":"","sources":["../../../../src/runtime/store/FilesSdk.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,OAAO,EAAE,iBAAiB,EAAE,mBAAmB,EAAE,cAAc,EAAE,kBAAkB,EAAE,mBAAmB,EAAsB,MAAM,cAAc,CAAC;AAC5J,OAAO,EAAE,YAAY,EAAE,MAAM,mBAAmB,CAAC;AAQjD,OAAO,EAAE,QAAQ,EAAE,MAAM,aAAa,CAAC;AAUvC,MAAM,OAAO,QAAS,SAAQ,OAAO;IACnC;;;;;;OAMG;IACH,KAAK,CAAC,IAAI,CAAC,KAAoD,EAAE,OAAsB,EAAE,UAA8B,EAAE;QACvH,MAAM,KAAK,GAAG,OAAO,CAAC,KAAK,IAAI,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC;QAC9C,MAAM,GAAG,GAAG,IAAI,CAAC,GAAG,CAAC,MAAM,CAAC,YAAY,CAAC,KAAK,EAAE,CAAC,CAAC;QAClD,IAAI,CAAC,GAAG,CAAC,iBAAiB,CAAC,GAAG,EAAE,OAAO,CAAC,CAAC;QACzC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,CAAC,GAAG,CAAC,YAAY,CAAC,MAAM,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC,CAAC;QACvD,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,QAAQ,EAAE,EAAE,EAAE,KAAK,EAAE,CAAC,CAAC;QAClE,IAAI,CAAC,wBAAwB,CAAC,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,IAAI,CAAC,CAAC;QAC1D,MAAM,QAAQ,GAAG,wBAAwB,CAAC;QAC1C,IAAI,MAAM,CAAC,MAAM,KAAK,GAAG,EAAE;YACzB,IAAI,CAAC,kBAAkB,CAAC,MAAM,CAAC,CAAC;YAChC,IAAI,CAAC,GAAG,IAAI,CAAC,qBAAqB,CAAC,MAAM,CAAC,IAAI,CAAC,CAAA;YAC/C,IAAI,CAAC,CAAC,EAAE;gBACN,CAAC,GAAG,IAAI,QAAQ,CAAC,GAAG,QAAQ,GAAG,iBAAiB,GAAG,MAAM,CAAC,MAAM,EAAE,EAAE,MAAM,CAAC,MAAM,CAAC,CAAC;gBACnF,CAAC,CAAC,QAAQ,GAAG,MAAM,CAAC,IAAI,CAAC;aAC1B;YACD,MAAM,CAAC,CAAC;SACT;QACD,IAAI,CAAC,MAAM,CAAC,IAAI,EAAE;YAChB,MAAM,IAAI,KAAK,CAAC,GAAG,QAAQ,GAAG,mBAAmB,EAAE,CAAC,CAAC;SACtD;QACD,IAAI,IAA0B,CAAC;QAC/B,IAAI;YACF,IAAI,GAAG,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;SAChC;QAAC,OAAO,CAAC,EAAE;YACV,MAAM,IAAI,KAAK,CAAC,GAAG,QAAQ,GAAG,cAAc,GAAG,CAAC,CAAC;SAClD;QACD,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE;YAC7B,MAAM,IAAI,KAAK,CAAC,GAAG,QAAQ,GAAG,kBAAkB,GAAG,CAAC,CAAC;SACtD;QACD,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;;;OAMG;IACH,KAAK,CAAC,MAAM,CAAC,IAA0B,EAAE,OAA2B,EAAE,EAAE,UAA8B,EAAE;QACtG,MAAM,KAAK,GAAG,OAAO,CAAC,KAAK,IAAI,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC;QAC9C,MAAM,IAAI,GAAG,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,YAAY,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,YAAY,CAAC,KAAK,EAAE,CAAC;QACjF,MAAM,GAAG,GAAG,IAAI,CAAC,GAAG,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;QAClC,MAAM,IAAI,GAAG,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC;QAClC,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,QAAQ,EAAE,EAAE,EAAE,KAAK,EAAE,IAAI,EAAE,CAAC,CAAC;QACzE,IAAI,CAAC,wBAAwB,CAAC,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,IAAI,CAAC,CAAC;QAC1D,MAAM,QAAQ,GAAG,2BAA2B,CAAC;QAC7C,IAAI,MAAM,CAAC,MAAM,KAAK,GAAG,EAAE;YACzB,IAAI,CAAC,kBAAkB,CAAC,MAAM,CAAC,CAAC;YAChC,IAAI,CAAC,GAAG,IAAI,CAAC,qBAAqB,CAAC,MAAM,CAAC,IAAI,CAAC,CAAA;YAC/C,IAAI,CAAC,CAAC,EAAE;gBACN,CAAC,GAAG,IAAI,QAAQ,CAAC,GAAG,QAAQ,GAAG,iBAAiB,GAAG,MAAM,CAAC,MAAM,EAAE,EAAE,MAAM,CAAC,MAAM,CAAC,CAAC;gBACnF,CAAC,CAAC,QAAQ,GAAG,MAAM,CAAC,IAAI,CAAC;aAC1B;YACD,MAAM,CAAC,CAAC;SACT;QACD,MAAM,QAAQ,GAAG,MAAM,CAAC,OAAO,CAAC,GAAG,CAAC,UAAU,CAAC,CAAC;QAChD,IAAI,CAAC,QAAQ,EAAE;YACb,MAAM,IAAI,KAAK,CAAC,GAAG,QAAQ,GAAG,mBAAmB,EAAE,CAAC,CAAC;SACtD;QACD,MAAM,EAAE,GAAG,QAAQ,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,CAAC;QACrC,OAAO,EAAY,CAAC;IACtB,CAAC;IAmBD;;;;;OAKG;IACH,KAAK,CAAC,IAAI,CAAC,GAAW,EAAE,KAAe,EAAE,UAA8B,EAAE;QACvE,MAAM,KAAK,GAAG,OAAO,CAAC,KAAK,IAAI,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC;QAC9C,MAAM,GAAG,GAAG,IAAI,CAAC,GAAG,CAAC,MAAM,CAAC,YAAY,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC;QACpD,IAAI,KAAK,EAAE;YACT,GAAG,CAAC,YAAY,CAAC,GAAG,CAAC,KAAK,EAAE,OAAO,CAAC,CAAC;SACtC;QACD,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,QAAQ,EAAE,EAAE,EAAE,KAAK,EAAE,CAAC,CAAC;QAClE,IAAI,CAAC,wBAAwB,CAAC,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,IAAI,CAAC,CAAC;QAC1D,MAAM,QAAQ,GAAG,yBAAyB,CAAC;QAC3C,IAAI,MAAM,CAAC,MAAM,KAAK,GAAG,EAAE;YACzB,IAAI,CAAC,kBAAkB,CAAC,MAAM,CAAC,CAAC;YAChC,IAAI,CAAC,GAAG,IAAI,CAAC,qBAAqB,CAAC,MAAM,CAAC,IAAI,CAAC,CAAA;YAC/C,IAAI,CAAC,CAAC,EAAE;gBACN,CAAC,GAAG,IAAI,QAAQ,CAAC,GAAG,QAAQ,GAAG,iBAAiB,GAAG,MAAM,CAAC,MAAM,EAAE,EAAE,MAAM,CAAC,MAAM,CAAC,CAAC;gBACnF,CAAC,CAAC,QAAQ,GAAG,MAAM,CAAC,IAAI,CAAC;aAC1B;YACD,MAAM,CAAC,CAAC;SACT;QACD,IAAI,CAAC,MAAM,CAAC,IAAI,EAAE;YAChB,MAAM,IAAI,KAAK,CAAC,GAAG,QAAQ,GAAG,mBAAmB,EAAE,CAAC,CAAC;SACtD;QACD,IAAI,IAAW,CAAC;QAChB,IAAI;YACF,IAAI,GAAG,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;SAChC;QAAC,OAAO,CAAC,EAAE;YACV,MAAM,IAAI,KAAK,CAAC,GAAG,QAAQ,GAAG,cAAc,GAAG,CAAC,CAAC;SAClD;QACD,IAAI,CAAC,IAAI,CAAC,IAAI,EAAE;YACd,MAAM,IAAI,KAAK,CAAC,GAAG,QAAQ,GAAG,kBAAkB,GAAG,CAAC,CAAC;SACtD;QACD,OAAO,IAAI,CAAC;IACd,CAAC;IAoBD;;;;;;OAMG;IACH,KAAK,CAAC,KAAK,CAAC,GAAW,EAAE,
|
|
1
|
+
{"version":3,"file":"FilesSdk.js","sourceRoot":"","sources":["../../../../src/runtime/store/FilesSdk.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,OAAO,EAAE,iBAAiB,EAAE,mBAAmB,EAAE,cAAc,EAAE,kBAAkB,EAAE,mBAAmB,EAAsB,MAAM,cAAc,CAAC;AAC5J,OAAO,EAAE,YAAY,EAAE,MAAM,mBAAmB,CAAC;AAQjD,OAAO,EAAE,QAAQ,EAAE,MAAM,aAAa,CAAC;AAUvC,MAAM,OAAO,QAAS,SAAQ,OAAO;IACnC;;;;;;OAMG;IACH,KAAK,CAAC,IAAI,CAAC,KAAoD,EAAE,OAAsB,EAAE,UAA8B,EAAE;QACvH,MAAM,KAAK,GAAG,OAAO,CAAC,KAAK,IAAI,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC;QAC9C,MAAM,GAAG,GAAG,IAAI,CAAC,GAAG,CAAC,MAAM,CAAC,YAAY,CAAC,KAAK,EAAE,CAAC,CAAC;QAClD,IAAI,CAAC,GAAG,CAAC,iBAAiB,CAAC,GAAG,EAAE,OAAO,CAAC,CAAC;QACzC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,CAAC,GAAG,CAAC,YAAY,CAAC,MAAM,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC,CAAC;QACvD,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,QAAQ,EAAE,EAAE,EAAE,KAAK,EAAE,CAAC,CAAC;QAClE,IAAI,CAAC,wBAAwB,CAAC,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,IAAI,CAAC,CAAC;QAC1D,MAAM,QAAQ,GAAG,wBAAwB,CAAC;QAC1C,IAAI,MAAM,CAAC,MAAM,KAAK,GAAG,EAAE;YACzB,IAAI,CAAC,kBAAkB,CAAC,MAAM,CAAC,CAAC;YAChC,IAAI,CAAC,GAAG,IAAI,CAAC,qBAAqB,CAAC,MAAM,CAAC,IAAI,CAAC,CAAA;YAC/C,IAAI,CAAC,CAAC,EAAE;gBACN,CAAC,GAAG,IAAI,QAAQ,CAAC,GAAG,QAAQ,GAAG,iBAAiB,GAAG,MAAM,CAAC,MAAM,EAAE,EAAE,MAAM,CAAC,MAAM,CAAC,CAAC;gBACnF,CAAC,CAAC,QAAQ,GAAG,MAAM,CAAC,IAAI,CAAC;aAC1B;YACD,MAAM,CAAC,CAAC;SACT;QACD,IAAI,CAAC,MAAM,CAAC,IAAI,EAAE;YAChB,MAAM,IAAI,KAAK,CAAC,GAAG,QAAQ,GAAG,mBAAmB,EAAE,CAAC,CAAC;SACtD;QACD,IAAI,IAA0B,CAAC;QAC/B,IAAI;YACF,IAAI,GAAG,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;SAChC;QAAC,OAAO,CAAC,EAAE;YACV,MAAM,IAAI,KAAK,CAAC,GAAG,QAAQ,GAAG,cAAc,GAAG,CAAC,CAAC;SAClD;QACD,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE;YAC7B,MAAM,IAAI,KAAK,CAAC,GAAG,QAAQ,GAAG,kBAAkB,GAAG,CAAC,CAAC;SACtD;QACD,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;;;OAMG;IACH,KAAK,CAAC,MAAM,CAAC,IAA0B,EAAE,OAA2B,EAAE,EAAE,UAA8B,EAAE;QACtG,MAAM,KAAK,GAAG,OAAO,CAAC,KAAK,IAAI,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC;QAC9C,MAAM,IAAI,GAAG,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,YAAY,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,YAAY,CAAC,KAAK,EAAE,CAAC;QACjF,MAAM,GAAG,GAAG,IAAI,CAAC,GAAG,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;QAClC,MAAM,IAAI,GAAG,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC;QAClC,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,QAAQ,EAAE,EAAE,EAAE,KAAK,EAAE,IAAI,EAAE,CAAC,CAAC;QACzE,IAAI,CAAC,wBAAwB,CAAC,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,IAAI,CAAC,CAAC;QAC1D,MAAM,QAAQ,GAAG,2BAA2B,CAAC;QAC7C,IAAI,MAAM,CAAC,MAAM,KAAK,GAAG,EAAE;YACzB,IAAI,CAAC,kBAAkB,CAAC,MAAM,CAAC,CAAC;YAChC,IAAI,CAAC,GAAG,IAAI,CAAC,qBAAqB,CAAC,MAAM,CAAC,IAAI,CAAC,CAAA;YAC/C,IAAI,CAAC,CAAC,EAAE;gBACN,CAAC,GAAG,IAAI,QAAQ,CAAC,GAAG,QAAQ,GAAG,iBAAiB,GAAG,MAAM,CAAC,MAAM,EAAE,EAAE,MAAM,CAAC,MAAM,CAAC,CAAC;gBACnF,CAAC,CAAC,QAAQ,GAAG,MAAM,CAAC,IAAI,CAAC;aAC1B;YACD,MAAM,CAAC,CAAC;SACT;QACD,MAAM,QAAQ,GAAG,MAAM,CAAC,OAAO,CAAC,GAAG,CAAC,UAAU,CAAC,CAAC;QAChD,IAAI,CAAC,QAAQ,EAAE;YACb,MAAM,IAAI,KAAK,CAAC,GAAG,QAAQ,GAAG,mBAAmB,EAAE,CAAC,CAAC;SACtD;QACD,MAAM,EAAE,GAAG,QAAQ,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,CAAC;QACrC,OAAO,EAAY,CAAC;IACtB,CAAC;IAmBD;;;;;OAKG;IACH,KAAK,CAAC,IAAI,CAAC,GAAW,EAAE,KAAe,EAAE,UAA8B,EAAE;QACvE,MAAM,KAAK,GAAG,OAAO,CAAC,KAAK,IAAI,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC;QAC9C,MAAM,GAAG,GAAG,IAAI,CAAC,GAAG,CAAC,MAAM,CAAC,YAAY,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC;QACpD,IAAI,KAAK,EAAE;YACT,GAAG,CAAC,YAAY,CAAC,GAAG,CAAC,KAAK,EAAE,OAAO,CAAC,CAAC;SACtC;QACD,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,QAAQ,EAAE,EAAE,EAAE,KAAK,EAAE,CAAC,CAAC;QAClE,IAAI,CAAC,wBAAwB,CAAC,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,IAAI,CAAC,CAAC;QAC1D,MAAM,QAAQ,GAAG,yBAAyB,CAAC;QAC3C,IAAI,MAAM,CAAC,MAAM,KAAK,GAAG,EAAE;YACzB,IAAI,CAAC,kBAAkB,CAAC,MAAM,CAAC,CAAC;YAChC,IAAI,CAAC,GAAG,IAAI,CAAC,qBAAqB,CAAC,MAAM,CAAC,IAAI,CAAC,CAAA;YAC/C,IAAI,CAAC,CAAC,EAAE;gBACN,CAAC,GAAG,IAAI,QAAQ,CAAC,GAAG,QAAQ,GAAG,iBAAiB,GAAG,MAAM,CAAC,MAAM,EAAE,EAAE,MAAM,CAAC,MAAM,CAAC,CAAC;gBACnF,CAAC,CAAC,QAAQ,GAAG,MAAM,CAAC,IAAI,CAAC;aAC1B;YACD,MAAM,CAAC,CAAC;SACT;QACD,IAAI,CAAC,MAAM,CAAC,IAAI,EAAE;YAChB,MAAM,IAAI,KAAK,CAAC,GAAG,QAAQ,GAAG,mBAAmB,EAAE,CAAC,CAAC;SACtD;QACD,IAAI,IAAW,CAAC;QAChB,IAAI;YACF,IAAI,GAAG,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;SAChC;QAAC,OAAO,CAAC,EAAE;YACV,MAAM,IAAI,KAAK,CAAC,GAAG,QAAQ,GAAG,cAAc,GAAG,CAAC,CAAC;SAClD;QACD,IAAI,CAAC,IAAI,CAAC,IAAI,EAAE;YACd,MAAM,IAAI,KAAK,CAAC,GAAG,QAAQ,GAAG,kBAAkB,GAAG,CAAC,CAAC;SACtD;QACD,OAAO,IAAI,CAAC;IACd,CAAC;IAoBD;;;;;;OAMG;IACH,KAAK,CAAC,KAAK,CAAC,GAAW,EAAE,KAAsB,EAAE,KAAe,EAAE,UAA8B,EAAE;QAChG,MAAM,KAAK,GAAG,OAAO,CAAC,KAAK,IAAI,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC;QAC9C,MAAM,GAAG,GAAG,IAAI,CAAC,GAAG,CAAC,MAAM,CAAC,YAAY,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC;QACpD,IAAI,KAAK,EAAE;YACT,GAAG,CAAC,YAAY,CAAC,GAAG,CAAC,KAAK,EAAE,OAAO,CAAC,CAAC;SACtC;QACD,MAAM,IAAI,GAAG,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC;QACnC,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,QAAQ,EAAE,EAAE,EAAE,KAAK,EAAE,IAAI,EAAE,CAAC,CAAC;QAC1E,IAAI,CAAC,wBAAwB,CAAC,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,IAAI,CAAC,CAAC;QAC1D,MAAM,QAAQ,GAAG,0BAA0B,CAAC;QAC5C,IAAI,MAAM,CAAC,MAAM,KAAK,GAAG,EAAE;YACzB,IAAI,CAAC,kBAAkB,CAAC,MAAM,CAAC,CAAC;YAChC,IAAI,CAAC,GAAG,IAAI,CAAC,qBAAqB,CAAC,MAAM,CAAC,IAAI,CAAC,CAAA;YAC/C,IAAI,CAAC,CAAC,EAAE;gBACN,CAAC,GAAG,IAAI,QAAQ,CAAC,GAAG,QAAQ,GAAG,iBAAiB,GAAG,MAAM,CAAC,MAAM,EAAE,EAAE,MAAM,CAAC,MAAM,CAAC,CAAC;gBACnF,CAAC,CAAC,QAAQ,GAAG,MAAM,CAAC,IAAI,CAAC;aAC1B;YACD,MAAM,CAAC,CAAC;SACT;QACD,IAAI,CAAC,MAAM,CAAC,IAAI,EAAE;YAChB,MAAM,IAAI,KAAK,CAAC,GAAG,QAAQ,GAAG,mBAAmB,EAAE,CAAC,CAAC;SACtD;QACD,IAAI,IAAS,CAAC;QACd,IAAI;YACF,IAAI,GAAG,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;SAChC;QAAC,OAAO,CAAC,EAAE;YACV,MAAM,IAAI,KAAK,CAAC,GAAG,QAAQ,GAAG,cAAc,GAAG,CAAC,CAAC;SAClD;QACD,IAAI,CAAC,IAAI,CAAC,MAAM,EAAE;YAChB,MAAM,IAAI,KAAK,CAAC,GAAG,QAAQ,GAAG,kBAAkB,GAAG,CAAC,CAAC;SACtD;QACD,OAAO,IAAI,CAAC,MAAyB,CAAC;IACxC,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,MAAM,CAAC,GAAW,EAAE,UAA8B,EAAE;QACxD,MAAM,KAAK,GAAG,OAAO,CAAC,KAAK,IAAI,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC;QAC9C,MAAM,GAAG,GAAG,IAAI,CAAC,GAAG,CAAC,MAAM,CAAC,YAAY,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC;QACpD,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,QAAQ,EAAE,EAAE,EAAE,KAAK,EAAE,CAAC,CAAC;QACrE,IAAI,CAAC,wBAAwB,CAAC,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,IAAI,CAAC,CAAC;QAC1D,MAAM,QAAQ,GAAG,2BAA2B,CAAC;QAC7C,IAAI,MAAM,CAAC,MAAM,KAAK,GAAG,EAAE;YACzB,IAAI,CAAC,kBAAkB,CAAC,MAAM,CAAC,CAAC;YAChC,IAAI,CAAC,GAAG,IAAI,CAAC,qBAAqB,CAAC,MAAM,CAAC,IAAI,CAAC,CAAA;YAC/C,IAAI,CAAC,CAAC,EAAE;gBACN,CAAC,GAAG,IAAI,QAAQ,CAAC,GAAG,QAAQ,GAAG,iBAAiB,GAAG,MAAM,CAAC,MAAM,EAAE,EAAE,MAAM,CAAC,MAAM,CAAC,CAAC;gBACnF,CAAC,CAAC,QAAQ,GAAG,MAAM,CAAC,IAAI,CAAC;aAC1B;YACD,MAAM,CAAC,CAAC;SACT;IACH,CAAC;IAED;;;;;;OAMG;IACH,KAAK,CAAC,UAAU,CAAC,GAAW,EAAE,KAAwB,EAAE,UAA8B,EAAE;QACtF,MAAM,KAAK,GAAG,OAAO,CAAC,KAAK,IAAI,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC;QAC9C,MAAM,GAAG,GAAG,IAAI,CAAC,GAAG,CAAC,MAAM,CAAC,YAAY,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC,CAAC;QACzD,MAAM,IAAI,GAAG,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC;QACnC,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,QAAQ,EAAE,EAAE,EAAE,KAAK,EAAE,IAAI,EAAE,CAAC,CAAC;QAC1E,IAAI,CAAC,wBAAwB,CAAC,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,IAAI,CAAC,CAAC;QAC1D,MAAM,QAAQ,GAAG,0BAA0B,CAAC;QAC5C,IAAI,MAAM,CAAC,MAAM,KAAK,GAAG,EAAE;YACzB,IAAI,CAAC,kBAAkB,CAAC,MAAM,CAAC,CAAC;YAChC,IAAI,CAAC,GAAG,IAAI,CAAC,qBAAqB,CAAC,MAAM,CAAC,IAAI,CAAC,CAAA;YAC/C,IAAI,CAAC,CAAC,EAAE;gBACN,CAAC,GAAG,IAAI,QAAQ,CAAC,GAAG,QAAQ,GAAG,iBAAiB,GAAG,MAAM,CAAC,MAAM,EAAE,EAAE,MAAM,CAAC,MAAM,CAAC,CAAC;gBACnF,CAAC,CAAC,QAAQ,GAAG,MAAM,CAAC,IAAI,CAAC;aAC1B;YACD,MAAM,CAAC,CAAC;SACT;IACH,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,SAAS,CAAC,GAAW,EAAE,UAA8B,EAAE;QAC3D,MAAM,KAAK,GAAG,OAAO,CAAC,KAAK,IAAI,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC;QAC9C,MAAM,GAAG,GAAG,IAAI,CAAC,GAAG,CAAC,MAAM,CAAC,YAAY,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC,CAAC;QACzD,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,QAAQ,EAAE,EAAE,EAAE,KAAK,EAAE,CAAC,CAAC;QAClE,IAAI,CAAC,wBAAwB,CAAC,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,IAAI,CAAC,CAAC;QAC1D,MAAM,QAAQ,GAAG,oCAAoC,CAAC;QACtD,IAAI,MAAM,CAAC,MAAM,KAAK,GAAG,EAAE;YACzB,IAAI,CAAC,kBAAkB,CAAC,MAAM,CAAC,CAAC;YAChC,IAAI,CAAC,GAAG,IAAI,CAAC,qBAAqB,CAAC,MAAM,CAAC,IAAI,CAAC,CAAA;YAC/C,IAAI,CAAC,CAAC,EAAE;gBACN,CAAC,GAAG,IAAI,QAAQ,CAAC,GAAG,QAAQ,GAAG,iBAAiB,GAAG,MAAM,CAAC,MAAM,EAAE,EAAE,MAAM,CAAC,MAAM,CAAC,CAAC;gBACnF,CAAC,CAAC,QAAQ,GAAG,MAAM,CAAC,IAAI,CAAC;aAC1B;YACD,MAAM,CAAC,CAAC;SACT;QACD,IAAI,CAAC,MAAM,CAAC,IAAI,EAAE;YAChB,MAAM,IAAI,KAAK,CAAC,GAAG,QAAQ,GAAG,mBAAmB,EAAE,CAAC,CAAC;SACtD;QACD,IAAI,IAA0B,CAAC;QAC/B,IAAI;YACF,IAAI,GAAG,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;SAChC;QAAC,OAAO,CAAC,EAAE;YACV,MAAM,IAAI,KAAK,CAAC,GAAG,QAAQ,GAAG,cAAc,GAAG,CAAC,CAAC;SAClD;QACD,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE;YAC7B,MAAM,IAAI,KAAK,CAAC,GAAG,QAAQ,GAAG,kBAAkB,GAAG,CAAC,CAAC;SACtD;QACD,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;OAGG;IACH,KAAK,CAAC,YAAY,CAAC,UAA8B,EAAE;QACjD,MAAM,KAAK,GAAG,OAAO,CAAC,KAAK,IAAI,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC;QAC9C,MAAM,GAAG,GAAG,IAAI,CAAC,GAAG,CAAC,MAAM,CAAC,YAAY,CAAC,KAAK,EAAE,CAAC,CAAC;QAClD,OAAO,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,gBAAgB,CAAC,GAAG,CAAC,QAAQ,EAAE,EAAE,KAAK,CAAC,CAAC;IAC7D,CAAC;CACF"}
|
package/package.json
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@api-client/core",
|
|
3
3
|
"description": "The API Client's core client library. Works in NodeJS and in a ES enabled browser.",
|
|
4
|
-
"version": "0.5.
|
|
4
|
+
"version": "0.5.6",
|
|
5
5
|
"license": "Apache-2.0",
|
|
6
6
|
"main": "build/index.js",
|
|
7
7
|
"module": "build/index.js",
|
|
@@ -31,7 +31,6 @@
|
|
|
31
31
|
"@types/cors": "^2.8.12",
|
|
32
32
|
"@types/express-ntlm": "^2.3.3",
|
|
33
33
|
"@types/fs-extra": "^9.0.13",
|
|
34
|
-
"@types/json8-patch": "^1.0.0",
|
|
35
34
|
"@types/mocha": "^9.0.0",
|
|
36
35
|
"@types/node": "^17.0.18",
|
|
37
36
|
"@types/sinon": "^10.0.11",
|
|
@@ -83,13 +82,13 @@
|
|
|
83
82
|
]
|
|
84
83
|
},
|
|
85
84
|
"dependencies": {
|
|
85
|
+
"@api-client/json": "^0.1.0",
|
|
86
86
|
"@metrichor/jmespath": "^0.3.1",
|
|
87
87
|
"@pawel-up/data-mock": "^0.2.0",
|
|
88
88
|
"@pawel-up/jexl": "^3.0.0",
|
|
89
89
|
"@xmldom/xmldom": "^0.8.1",
|
|
90
90
|
"console-table-printer": "^2.10.0",
|
|
91
91
|
"form-data": "^4.0.0",
|
|
92
|
-
"json8-patch": "^1.0.6",
|
|
93
92
|
"ws": "^8.5.0",
|
|
94
93
|
"xpath": "^0.0.32"
|
|
95
94
|
},
|
|
@@ -4,7 +4,7 @@ export const Kind = 'Core#Revision';
|
|
|
4
4
|
|
|
5
5
|
/**
|
|
6
6
|
* The definition of a patch revision.
|
|
7
|
-
* The revision is created with the
|
|
7
|
+
* The revision is created with the `@api-client/json` library.
|
|
8
8
|
*/
|
|
9
9
|
export interface IRevisionInfo {
|
|
10
10
|
/**
|
|
@@ -33,7 +33,7 @@ export interface IRevisionInfo {
|
|
|
33
33
|
*/
|
|
34
34
|
deleted?: boolean;
|
|
35
35
|
/**
|
|
36
|
-
* The
|
|
36
|
+
* The `@api-client/json` revisions object used to restore the previous state.
|
|
37
37
|
*/
|
|
38
38
|
patch: any[];
|
|
39
39
|
/**
|
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
import WebSocketNode from 'ws';
|
|
2
|
-
import {
|
|
2
|
+
import { Patch } from '@api-client/json';
|
|
3
3
|
import { SdkBase, E_RESPONSE_STATUS, E_RESPONSE_NO_VALUE, E_INVALID_JSON, E_RESPONSE_UNKNOWN, E_RESPONSE_LOCATION, ISdkRequestOptions } from './SdkBase.js';
|
|
4
4
|
import { RouteBuilder } from './RouteBuilder.js';
|
|
5
5
|
import { IListOptions, IListResponse } from '../../models/Backend.js';
|
|
@@ -154,7 +154,7 @@ export class FilesSdk extends SdkBase {
|
|
|
154
154
|
* @param value The patch to apply.
|
|
155
155
|
* @param request Optional request options.
|
|
156
156
|
*/
|
|
157
|
-
patch(key: string, value: JsonPatch, media: false, request?: ISdkRequestOptions): Promise<JsonPatch>;
|
|
157
|
+
patch(key: string, value: Patch.JsonPatch, media: false, request?: ISdkRequestOptions): Promise<Patch.JsonPatch>;
|
|
158
158
|
|
|
159
159
|
/**
|
|
160
160
|
* Patches file's content in the store.
|
|
@@ -163,16 +163,16 @@ export class FilesSdk extends SdkBase {
|
|
|
163
163
|
* @param value The patch to apply.
|
|
164
164
|
* @param request Optional request options.
|
|
165
165
|
*/
|
|
166
|
-
patch(key: string, value: JsonPatch, media: true, request?: ISdkRequestOptions): Promise<JsonPatch>;
|
|
166
|
+
patch(key: string, value: Patch.JsonPatch, media: true, request?: ISdkRequestOptions): Promise<Patch.JsonPatch>;
|
|
167
167
|
|
|
168
168
|
/**
|
|
169
169
|
* Patches a file in the store.
|
|
170
170
|
* @param key The key of the file to patch
|
|
171
171
|
* @param value The JSON patch to be processed.
|
|
172
172
|
* @param request Optional request options.
|
|
173
|
-
* @returns The JSON patch to revert the change using the
|
|
173
|
+
* @returns The JSON patch to revert the change using the `@api-client/json` library
|
|
174
174
|
*/
|
|
175
|
-
async patch(key: string, value: JsonPatch, media?: boolean, request: ISdkRequestOptions = {}): Promise<JsonPatch> {
|
|
175
|
+
async patch(key: string, value: Patch.JsonPatch, media?: boolean, request: ISdkRequestOptions = {}): Promise<Patch.JsonPatch> {
|
|
176
176
|
const token = request.token || this.sdk.token;
|
|
177
177
|
const url = this.sdk.getUrl(RouteBuilder.file(key));
|
|
178
178
|
if (media) {
|
|
@@ -203,7 +203,7 @@ export class FilesSdk extends SdkBase {
|
|
|
203
203
|
if (!data.revert) {
|
|
204
204
|
throw new Error(`${E_PREFIX}${E_RESPONSE_UNKNOWN}.`);
|
|
205
205
|
}
|
|
206
|
-
return data.revert as JsonPatch;
|
|
206
|
+
return data.revert as Patch.JsonPatch;
|
|
207
207
|
}
|
|
208
208
|
|
|
209
209
|
/**
|
package/json8-patch.d.ts
DELETED
|
@@ -1,270 +0,0 @@
|
|
|
1
|
-
declare module "json8-patch" {
|
|
2
|
-
export interface BaseOperation {
|
|
3
|
-
path: string;
|
|
4
|
-
}
|
|
5
|
-
|
|
6
|
-
export interface AddOperation extends BaseOperation {
|
|
7
|
-
op: "add";
|
|
8
|
-
value: any;
|
|
9
|
-
}
|
|
10
|
-
|
|
11
|
-
export interface RemoveOperation extends BaseOperation {
|
|
12
|
-
op: "remove";
|
|
13
|
-
}
|
|
14
|
-
|
|
15
|
-
/**
|
|
16
|
-
* The JSON patch replace operation
|
|
17
|
-
*/
|
|
18
|
-
export interface ReplaceOperation extends BaseOperation {
|
|
19
|
-
op: "replace";
|
|
20
|
-
value: any;
|
|
21
|
-
}
|
|
22
|
-
|
|
23
|
-
/**
|
|
24
|
-
* The JSON patch move operation
|
|
25
|
-
*/
|
|
26
|
-
export interface MoveOperation extends BaseOperation {
|
|
27
|
-
op: "move";
|
|
28
|
-
from: any;
|
|
29
|
-
}
|
|
30
|
-
|
|
31
|
-
/**
|
|
32
|
-
* The JSON patch copy operation.
|
|
33
|
-
*/
|
|
34
|
-
export interface CopyOperation extends BaseOperation {
|
|
35
|
-
op: "copy";
|
|
36
|
-
from: any;
|
|
37
|
-
}
|
|
38
|
-
|
|
39
|
-
/**
|
|
40
|
-
* The JSON patch test operation
|
|
41
|
-
*/
|
|
42
|
-
export interface TestOperation extends BaseOperation {
|
|
43
|
-
op: "test";
|
|
44
|
-
value: any;
|
|
45
|
-
}
|
|
46
|
-
|
|
47
|
-
/**
|
|
48
|
-
* All possible JSON patch operations
|
|
49
|
-
*/
|
|
50
|
-
export type JsonPatchOperation = AddOperation | RemoveOperation | ReplaceOperation | MoveOperation | CopyOperation | TestOperation;
|
|
51
|
-
|
|
52
|
-
/**
|
|
53
|
-
* A JSON patch as specified in RFC 6902
|
|
54
|
-
*/
|
|
55
|
-
export type JsonPatch = JsonPatchOperation[];
|
|
56
|
-
|
|
57
|
-
export interface ApplyResult<T> {
|
|
58
|
-
doc: T;
|
|
59
|
-
}
|
|
60
|
-
|
|
61
|
-
export interface ApplyResultWithRevert<T> extends ApplyResult<T> {
|
|
62
|
-
revert: JsonPatch;
|
|
63
|
-
}
|
|
64
|
-
|
|
65
|
-
export type PatchResult<T> = ApplyResult<T>;
|
|
66
|
-
export type PatchResultWithRevert<T> = ApplyResultWithRevert<T>;
|
|
67
|
-
|
|
68
|
-
/**
|
|
69
|
-
* The operation is atomic, if any of the patch operation fails, the document will be restored to its original state and an error will be thrown.
|
|
70
|
-
* @param doc The document to apply the patch operation to
|
|
71
|
-
* @param patch The patch operations
|
|
72
|
-
* @param options With `{reversible: false}` it will not return an additional value in the form of a `revert` property.
|
|
73
|
-
* @returns An object with a doc property because per specification a patch can replace the original root document.
|
|
74
|
-
*/
|
|
75
|
-
export function apply<T>(doc: T, patch: JsonPatch, options?: { reversible: false }): ApplyResult<T>;
|
|
76
|
-
/**
|
|
77
|
-
* The operation is atomic, if any of the patch operation fails, the document will be restored to its original state and an error will be thrown.
|
|
78
|
-
* @param doc The document to apply the patch operation to
|
|
79
|
-
* @param patch The patch operations
|
|
80
|
-
* @param options With `{reversible: true}` it will return an additional value in the form of a `revert` property.
|
|
81
|
-
* @returns An object with a doc property because per specification a patch can replace the original root document.
|
|
82
|
-
*/
|
|
83
|
-
export function apply<T>(doc: T, patch: JsonPatch, options?: { reversible: true }): ApplyResultWithRevert<T>;
|
|
84
|
-
/**
|
|
85
|
-
* Alias for the `apply()` method.
|
|
86
|
-
*/
|
|
87
|
-
export function patch<T>(doc: T, patch: JsonPatch, options?: { reversible: false }): PatchResult<T>;
|
|
88
|
-
/**
|
|
89
|
-
* Alias for the `apply()` method.
|
|
90
|
-
*/
|
|
91
|
-
export function patch<T>(doc: T, patch: JsonPatch, options?: { reversible: true }): PatchResultWithRevert<T>;
|
|
92
|
-
/**
|
|
93
|
-
* ```javascript
|
|
94
|
-
* ooPatch.diff(true, false);
|
|
95
|
-
* // [{"op": "replace", "path": "", "value": "false"}]
|
|
96
|
-
*
|
|
97
|
-
* ooPatch.diff([], []);
|
|
98
|
-
* // []
|
|
99
|
-
*
|
|
100
|
-
* ooPatch.diff({}, { foo: "bar" });
|
|
101
|
-
* // [{"op": "add", "path": "/foo", "value": "bar"}]
|
|
102
|
-
* ```
|
|
103
|
-
*
|
|
104
|
-
* @returns A diff in the form of a JSON Patch for 2 JSON values.
|
|
105
|
-
*/
|
|
106
|
-
export function diff(doc1: unknown, doc2: unknown): JsonPatch;
|
|
107
|
-
/**
|
|
108
|
-
* If the patch or apply method is called with a third argument `{reversible: true}` it will return an additional value in the form of a revert property.
|
|
109
|
-
*
|
|
110
|
-
* The revert object can be used to revert a patch on a document.
|
|
111
|
-
*
|
|
112
|
-
* ```javascript
|
|
113
|
-
* // apply the patch with the reversible option
|
|
114
|
-
* var applyResult = ooPatch.apply(doc, patch, { reversible: true });
|
|
115
|
-
* doc = applyResult.doc;
|
|
116
|
-
*
|
|
117
|
-
* // revert the patch
|
|
118
|
-
* doc = ooPatch.revert(doc, applyResult.revert).doc;
|
|
119
|
-
* // doc is strictly identical to the original
|
|
120
|
-
* ```
|
|
121
|
-
*
|
|
122
|
-
* See also the `buildRevertPatch()` function which offers more flexibility.
|
|
123
|
-
*/
|
|
124
|
-
export function revert<T>(doc: T, revertPatch: JsonPatch): ApplyResult<T>;
|
|
125
|
-
/**
|
|
126
|
-
* This method only check for JSON Patch semantic.
|
|
127
|
-
*
|
|
128
|
-
* ```javascript
|
|
129
|
-
* ooPatch.valid({}) // false
|
|
130
|
-
* ooPatch.valid([{}] // false
|
|
131
|
-
* ooPatch.valid([{op: "foo", path: null, value: undefined}]) // false
|
|
132
|
-
* ooPatch.valid([{op: "add", path: "/foo"}]) // false
|
|
133
|
-
*
|
|
134
|
-
* ooPatch.valid([]) // true
|
|
135
|
-
* ooPatch.valid([{op: "add", path: "/foo", value: "bar"}]) // true
|
|
136
|
-
* ```
|
|
137
|
-
*
|
|
138
|
-
* @returns `true` if the patch is valid, `false` otherwise.
|
|
139
|
-
*/
|
|
140
|
-
export function valid(patch: JsonPatch): boolean;
|
|
141
|
-
/**
|
|
142
|
-
* Builds a valid JSON Patch from the result of a reversible `apply` operation.
|
|
143
|
-
* You can then use this patch with `apply()` method to revert a previously applied patch.
|
|
144
|
-
*
|
|
145
|
-
* Because `buildRevertPatch` + `apply` offers more flexibility over `revert` it is preferred.
|
|
146
|
-
*
|
|
147
|
-
* - use pack/unpack with the result of `buildRevertPatch` making it ideal for storage or transport
|
|
148
|
-
* - reverse a revert (and so on...) with `{reversible: true}`
|
|
149
|
-
* - `diff` between reverts
|
|
150
|
-
* - merge multiple reverts into one
|
|
151
|
-
* - rebase reverts
|
|
152
|
-
*
|
|
153
|
-
* @param revert The revert value from the `apply()` or `patch()` method with `{reversible: true}`
|
|
154
|
-
* @returns JSON Patch
|
|
155
|
-
*/
|
|
156
|
-
export function buildRevertPatch(revert: JsonPatch): JsonPatch;
|
|
157
|
-
|
|
158
|
-
export interface OperationResult<T> {
|
|
159
|
-
/**
|
|
160
|
-
* The patched document
|
|
161
|
-
*/
|
|
162
|
-
doc: T;
|
|
163
|
-
/**
|
|
164
|
-
* The previous/replaced value if any
|
|
165
|
-
*/
|
|
166
|
-
previous?: T;
|
|
167
|
-
idx?: number;
|
|
168
|
-
}
|
|
169
|
-
|
|
170
|
-
/**
|
|
171
|
-
* Add the value to the specified JSON Pointer location.
|
|
172
|
-
* @param doc JSON document to set the value to
|
|
173
|
-
* @param path JSON Pointer string or tokens path
|
|
174
|
-
* @param value The value to add
|
|
175
|
-
*/
|
|
176
|
-
export function add<T>(doc: T, path: string | string[], value: unknown): OperationResult<T>;
|
|
177
|
-
/**
|
|
178
|
-
* Copy the value at the specified JSON Pointer location to another location.
|
|
179
|
-
*
|
|
180
|
-
* @param doc JSON document to copy the value from and to
|
|
181
|
-
* @param path JSON Pointer string or tokens path
|
|
182
|
-
* @param dest JSON Pointer string destination of the value
|
|
183
|
-
*/
|
|
184
|
-
export function copy<T>(doc: T, path: string | string[], dest: string): OperationResult<T>;
|
|
185
|
-
/**
|
|
186
|
-
* Moves the value at the specified JSON Pointer location to another location.
|
|
187
|
-
*
|
|
188
|
-
* @param doc JSON document to move the value from and to
|
|
189
|
-
* @param path JSON Pointer string or tokens path
|
|
190
|
-
* @param dest JSON Pointer string destination of the value
|
|
191
|
-
*/
|
|
192
|
-
export function move<T>(doc: T, path: string | string[], dest: string): OperationResult<T>;
|
|
193
|
-
/**
|
|
194
|
-
* Removes the value at the JSON Pointer location.
|
|
195
|
-
*
|
|
196
|
-
* @param doc JSON document to search into
|
|
197
|
-
* @param path JSON Pointer string or tokens patch
|
|
198
|
-
*/
|
|
199
|
-
export function remove<T>(doc: T, path: string | string[]): OperationResult<T>;
|
|
200
|
-
/**
|
|
201
|
-
* Replaces the value at the JSON Pointer location
|
|
202
|
-
*
|
|
203
|
-
* @param doc JSON document
|
|
204
|
-
* @param path JSON Pointer string or tokens patch
|
|
205
|
-
* @param value JSON object to replace with
|
|
206
|
-
*/
|
|
207
|
-
export function replace<T>(doc: T, path: string | string[], value: unknown): OperationResult<T>;
|
|
208
|
-
/**
|
|
209
|
-
* Tests that the value at the specified JSON Pointer location is equal to the specified value.
|
|
210
|
-
*
|
|
211
|
-
* @param doc JSON document
|
|
212
|
-
* @param path JSON Pointer string or tokens patch
|
|
213
|
-
* @param value The value to compare with
|
|
214
|
-
*/
|
|
215
|
-
export function test<T>(doc: T, path: string | string[], value: unknown): OperationResult<T>;
|
|
216
|
-
/**
|
|
217
|
-
* Get the value at the JSON Pointer location.
|
|
218
|
-
*
|
|
219
|
-
* @param doc JSON document
|
|
220
|
-
* @param path JSON Pointer string or tokens patch
|
|
221
|
-
* @returns The value at the JSON Pointer location
|
|
222
|
-
*/
|
|
223
|
-
export function get(doc: unknown, path: string | string[]): unknown;
|
|
224
|
-
/**
|
|
225
|
-
* Checks if the document has the property at the specified JSON Pointer location.
|
|
226
|
-
*
|
|
227
|
-
* @param doc JSON document
|
|
228
|
-
* @param path JSON Pointer string or tokens path
|
|
229
|
-
*/
|
|
230
|
-
export function has(doc: unknown, path: string | string[]): boolean;
|
|
231
|
-
/**
|
|
232
|
-
* Per specification patches are pretty verbose. JSON8 provides the `pack()` and the `unpack()` methods
|
|
233
|
-
* to reduce the size of patches and save memory / space / bandwidth.
|
|
234
|
-
*
|
|
235
|
-
* ```javascript
|
|
236
|
-
* var patch = [
|
|
237
|
-
* { op: "add", path: "/a/b/c", value: ["foo", "bar"] },
|
|
238
|
-
* { op: "remove", path: "/a/b/c" },
|
|
239
|
-
* { op: "replace", path: "/a/b/c", value: 42 },
|
|
240
|
-
* { op: "move", from: "/a/b/c", path: "/a/b/d" },
|
|
241
|
-
* { op: "copy", from: "/a/b/c", path: "/a/b/e" },
|
|
242
|
-
* { op: "test", path: "/a/b/c", value: "foo" },
|
|
243
|
-
* ];
|
|
244
|
-
*
|
|
245
|
-
* var packed = ooPatch.pack(patch);
|
|
246
|
-
*
|
|
247
|
-
* // [
|
|
248
|
-
* // [0, "/a/b/c", ["foo", "bar"]],
|
|
249
|
-
* // [1, "/a/b/c"],
|
|
250
|
-
* // [2, "/a/b/c", 42],
|
|
251
|
-
* // [3, "/a/b/d", "/a/b/c"],
|
|
252
|
-
* // [4, "/a/b/e", "/a/b/c"],
|
|
253
|
-
* // [5, "/a/b/c", "foo"]
|
|
254
|
-
* // ]
|
|
255
|
-
* ```
|
|
256
|
-
*/
|
|
257
|
-
export function pack(patch: JsonPatch): any[];
|
|
258
|
-
/**
|
|
259
|
-
* Reverses the `pack()` on a patch.
|
|
260
|
-
*
|
|
261
|
-
* @param packed Previously packed values.
|
|
262
|
-
* @returns Restored patch value.
|
|
263
|
-
*/
|
|
264
|
-
export function unpack(packed: any[]): JsonPatch;
|
|
265
|
-
/**
|
|
266
|
-
* Concatenates multiple patches into one.
|
|
267
|
-
*/
|
|
268
|
-
export function concat(...patches: JsonPatch): JsonPatch;
|
|
269
|
-
|
|
270
|
-
}
|