@or-sdk/cards 1.2.10-beta.4275.0 → 1.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 +9 -0
- package/README.md +11 -0
- package/dist/types/Cards.d.ts +68 -0
- package/dist/types/Cards.d.ts.map +1 -1
- package/package.json +5 -4
package/CHANGELOG.md
CHANGED
|
@@ -3,6 +3,15 @@
|
|
|
3
3
|
All notable changes to this project will be documented in this file.
|
|
4
4
|
See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
|
|
5
5
|
|
|
6
|
+
## [1.3.0](https://gitlab.internal.onereach.io/onereach/platform/or-sdk-next/compare/@or-sdk/cards@1.2.9...@or-sdk/cards@1.3.0) (2026-08-05)
|
|
7
|
+
|
|
8
|
+
|
|
9
|
+
### Features
|
|
10
|
+
|
|
11
|
+
* **packages:** add package descriptions and published files metadata ([801f823](https://gitlab.internal.onereach.io/onereach/platform/or-sdk-next/commit/801f823034717ef8b961405a73d51ebc2ec07649))
|
|
12
|
+
|
|
13
|
+
|
|
14
|
+
|
|
6
15
|
## [1.2.9](https://gitlab.internal.onereach.io/onereach/platform/or-sdk-next/compare/@or-sdk/cards@1.2.4...@or-sdk/cards@1.2.9) (2026-08-04)
|
|
7
16
|
|
|
8
17
|
**Note:** Version bump only for package @or-sdk/cards
|
package/README.md
CHANGED
|
@@ -64,3 +64,14 @@ const cards = new Cards({
|
|
|
64
64
|
## More detail
|
|
65
65
|
|
|
66
66
|
Full signatures and exported types are available in `src/` and `dist/types/`.
|
|
67
|
+
|
|
68
|
+
|
|
69
|
+
## Additional API reference
|
|
70
|
+
|
|
71
|
+
Methods below were missing from the package guide. Signatures and return types are taken directly from the exported source API.
|
|
72
|
+
|
|
73
|
+
### `Cards`
|
|
74
|
+
|
|
75
|
+
| Method | Returns | Purpose |
|
|
76
|
+
|---|---|---|
|
|
77
|
+
| `removeTags(source: Card, tagNames: string[])` | `Promise<Card>` | Remove tags |
|
package/dist/types/Cards.d.ts
CHANGED
|
@@ -5,16 +5,84 @@ export declare class Cards implements Taggable<Card> {
|
|
|
5
5
|
private readonly dataHubSvc;
|
|
6
6
|
private readonly tags;
|
|
7
7
|
constructor(params: CardsConfig);
|
|
8
|
+
/**
|
|
9
|
+
* List cards
|
|
10
|
+
* ```typescript
|
|
11
|
+
* const cardList = await cards.listCards();
|
|
12
|
+
* ```
|
|
13
|
+
*/
|
|
8
14
|
listCards(params?: ListCardsParams, paginationOptions?: PaginationOptions): Promise<List<Card>>;
|
|
15
|
+
/**
|
|
16
|
+
* Get card
|
|
17
|
+
* ```typescript
|
|
18
|
+
* const card = await cards.getCard('card-id');
|
|
19
|
+
* ```
|
|
20
|
+
*/
|
|
9
21
|
getCard(id: string): Promise<Card>;
|
|
22
|
+
/**
|
|
23
|
+
* Save card
|
|
24
|
+
*
|
|
25
|
+
* If source contains existing id - existing card will be updated
|
|
26
|
+
* ```typescript
|
|
27
|
+
* const savedCard = await cards.saveCard(cardSource);
|
|
28
|
+
* ```
|
|
29
|
+
*/
|
|
10
30
|
saveCard(source: Card): Promise<Card>;
|
|
31
|
+
/**
|
|
32
|
+
* Create card
|
|
33
|
+
* ```typescript
|
|
34
|
+
* const card = await cards.createCard(cardSource);
|
|
35
|
+
* ```
|
|
36
|
+
*/
|
|
11
37
|
createCard(source: Card): Promise<Card>;
|
|
38
|
+
/**
|
|
39
|
+
* Update card
|
|
40
|
+
* ```typescript
|
|
41
|
+
* const card = await cards.updateCard(cardSource);
|
|
42
|
+
* ```
|
|
43
|
+
*/
|
|
12
44
|
updateCard(source: Card): Promise<Card>;
|
|
45
|
+
/**
|
|
46
|
+
* Delete card
|
|
47
|
+
* ```typescript
|
|
48
|
+
* await cards.deleteCard('card-id');
|
|
49
|
+
* ```
|
|
50
|
+
*/
|
|
13
51
|
deleteCard(cardId: string, temporarily?: boolean): Promise<void>;
|
|
52
|
+
/**
|
|
53
|
+
* Recover card
|
|
54
|
+
* ```typescript
|
|
55
|
+
* await cards.recoverCard('card-id');
|
|
56
|
+
* ```
|
|
57
|
+
*/
|
|
14
58
|
recoverCard(cardId: string): Promise<void>;
|
|
59
|
+
/**
|
|
60
|
+
* Clone card
|
|
61
|
+
* ```typescript
|
|
62
|
+
* const result = await cards.cloneCard('card-id');
|
|
63
|
+
* ```
|
|
64
|
+
*/
|
|
15
65
|
cloneCard(cardId: string, keepTemplateDetails?: boolean): Promise<Card>;
|
|
66
|
+
/**
|
|
67
|
+
* Clone card
|
|
68
|
+
* ```typescript
|
|
69
|
+
* const result = await cards.cloneCard('card-id');
|
|
70
|
+
* ```
|
|
71
|
+
*/
|
|
16
72
|
cloneLibraryCard(cardId: string, viewIds: string[]): Promise<Card>;
|
|
73
|
+
/**
|
|
74
|
+
* Add tags
|
|
75
|
+
* ```typescript
|
|
76
|
+
* const card = await cards.addTags(cardSource, tagIdsArr);
|
|
77
|
+
* ```
|
|
78
|
+
*/
|
|
17
79
|
addTags(source: Card, tagNames: string[]): Promise<Card>;
|
|
80
|
+
/**
|
|
81
|
+
* Remove tags
|
|
82
|
+
* ```typescript
|
|
83
|
+
* const card = await cards.removeTags(cardSource, tagIdsArr);
|
|
84
|
+
* ```
|
|
85
|
+
*/
|
|
18
86
|
removeTags(source: Card, tagNames: string[]): Promise<Card>;
|
|
19
87
|
}
|
|
20
88
|
//# sourceMappingURL=Cards.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"Cards.d.ts","sourceRoot":"","sources":["../../src/Cards.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,IAAI,EAAY,MAAM,cAAc,CAAC;AAE9C,OAAO,EAAE,QAAQ,EAAgD,MAAM,cAAc,CAAC;AAEtF,OAAO,EAAE,IAAI,EAAE,WAAW,EAAE,eAAe,EAAE,iBAAiB,EAAE,MAAM,SAAS,CAAC;AAEhF,qBAAa,KAAM,YAAW,QAAQ,CAAC,IAAI,CAAC;IAC1C,OAAO,CAAC,QAAQ,CAAC,UAAU,CAAa;IACxC,OAAO,CAAC,QAAQ,CAAC,IAAI,CAAO;gBAEhB,MAAM,EAAE,WAAW;
|
|
1
|
+
{"version":3,"file":"Cards.d.ts","sourceRoot":"","sources":["../../src/Cards.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,IAAI,EAAY,MAAM,cAAc,CAAC;AAE9C,OAAO,EAAE,QAAQ,EAAgD,MAAM,cAAc,CAAC;AAEtF,OAAO,EAAE,IAAI,EAAE,WAAW,EAAE,eAAe,EAAE,iBAAiB,EAAE,MAAM,SAAS,CAAC;AAEhF,qBAAa,KAAM,YAAW,QAAQ,CAAC,IAAI,CAAC;IAC1C,OAAO,CAAC,QAAQ,CAAC,UAAU,CAAa;IACxC,OAAO,CAAC,QAAQ,CAAC,IAAI,CAAO;gBAEhB,MAAM,EAAE,WAAW;IAmB/B;;;;;OAKG;IACU,SAAS,CAAC,MAAM,GAAE,eAAoB,EAAE,iBAAiB,GAAE,iBAAsB,GAAG,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IAcpH;;;;;OAKG;IACU,OAAO,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAU/C;;;;;;;OAOG;IACU,QAAQ,CAAC,MAAM,EAAE,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC;IAIlD;;;;;OAKG;IACU,UAAU,CAAC,MAAM,EAAE,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC;IAkBpD;;;;;OAKG;IACU,UAAU,CAAC,MAAM,EAAE,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC;IAepD;;;;;OAKG;IACU,UAAU,CAAC,MAAM,EAAE,MAAM,EAAE,WAAW,UAAO,GAAG,OAAO,CAAC,IAAI,CAAC;IAa1E;;;;;OAKG;IACU,WAAW,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAUvD;;;;;OAKG;IACU,SAAS,CAAC,MAAM,EAAE,MAAM,EAAE,mBAAmB,UAAO,GAAG,OAAO,CAAC,IAAI,CAAC;IAajF;;;;;OAKG;IACU,gBAAgB,CAAC,MAAM,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC,IAAI,CAAC;IAa/E;;;;;OAKG;IACU,OAAO,CAAC,MAAM,EAAE,IAAI,EAAE,QAAQ,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC,IAAI,CAAC;IAmBrE;;;;;OAKG;IACU,UAAU,CAAC,MAAM,EAAE,IAAI,EAAE,QAAQ,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC,IAAI,CAAC;CAmBzE"}
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@or-sdk/cards",
|
|
3
|
-
"version": "1.
|
|
3
|
+
"version": "1.3.0",
|
|
4
4
|
"description": "OneReach SDK client for Cards",
|
|
5
5
|
"license": "Apache-2.0",
|
|
6
6
|
"main": "dist/cjs/index.js",
|
|
@@ -26,8 +26,8 @@
|
|
|
26
26
|
},
|
|
27
27
|
"dependencies": {
|
|
28
28
|
"@or-sdk/base": "^0.44.7",
|
|
29
|
-
"@or-sdk/data-hub-svc": "^2.
|
|
30
|
-
"@or-sdk/tags": "^1.
|
|
29
|
+
"@or-sdk/data-hub-svc": "^2.4.0",
|
|
30
|
+
"@or-sdk/tags": "^1.2.0"
|
|
31
31
|
},
|
|
32
32
|
"devDependencies": {
|
|
33
33
|
"concurrently": "9.0.1",
|
|
@@ -35,5 +35,6 @@
|
|
|
35
35
|
},
|
|
36
36
|
"publishConfig": {
|
|
37
37
|
"access": "public"
|
|
38
|
-
}
|
|
38
|
+
},
|
|
39
|
+
"gitHead": "6dc62c7c3a3a05b2dfc5a1c7c9bfd4c5e8eb0b99"
|
|
39
40
|
}
|