@openfn/language-beyonic 0.3.9 → 0.3.10

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 (3) hide show
  1. package/ast.json +6 -3
  2. package/package.json +1 -2
  3. package/types/Adaptor.d.ts +6 -17
package/ast.json CHANGED
@@ -10,7 +10,8 @@
10
10
  "tags": [
11
11
  {
12
12
  "title": "example",
13
- "description": "execute(\n createPayment(data)\n)(state)"
13
+ "description": "createPayment(data)",
14
+ "caption": "Create a payment with a reference to a customer"
14
15
  },
15
16
  {
16
17
  "title": "public",
@@ -53,7 +54,8 @@
53
54
  "tags": [
54
55
  {
55
56
  "title": "example",
56
- "description": "execute(\n createContact(data)\n)(state)"
57
+ "description": "createContact(data)",
58
+ "caption": "Create a contact"
57
59
  },
58
60
  {
59
61
  "title": "public",
@@ -96,7 +98,8 @@
96
98
  "tags": [
97
99
  {
98
100
  "title": "example",
99
- "description": "execute(\n createCollectionRequest(data)\n)(state)"
101
+ "description": "createCollectionRequest(data)",
102
+ "caption": "Create a collection request"
100
103
  },
101
104
  {
102
105
  "title": "public",
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@openfn/language-beyonic",
3
- "version": "0.3.9",
3
+ "version": "0.3.10",
4
4
  "description": "beyonic Language Pack for OpenFn",
5
5
  "homepage": "https://docs.openfn.org",
6
6
  "repository": {
@@ -30,7 +30,6 @@
30
30
  "@openfn/language-common": "2.3.0"
31
31
  },
32
32
  "devDependencies": {
33
- "@openfn/simple-ast": "0.4.1",
34
33
  "assertion-error": "2.0.0",
35
34
  "chai": "4.3.6",
36
35
  "deep-eql": "4.1.1",
package/types/Adaptor.d.ts CHANGED
@@ -1,11 +1,6 @@
1
1
  /**
2
2
  * Execute a sequence of operations.
3
3
  * Wraps `language-common/execute`, and prepends initial state for beyonic.
4
- * @example
5
- * execute(
6
- * create('foo'),
7
- * delete('bar')
8
- * )(state)
9
4
  * @private
10
5
  * @param {Operations} operations - Operations to be performed.
11
6
  * @returns {Operation}
@@ -13,10 +8,8 @@
13
8
  export function execute(...operations: Operations): Operation;
14
9
  /**
15
10
  * Create a payment
16
- * @example
17
- * execute(
18
- * createPayment(data)
19
- * )(state)
11
+ * @example <caption>Create a payment with a reference to a customer</caption>
12
+ * createPayment(data)
20
13
  * @public
21
14
  * @function
22
15
  * @param {object} data - Payload data for the payment
@@ -25,10 +18,8 @@ export function execute(...operations: Operations): Operation;
25
18
  export function createPayment(data: object): Operation;
26
19
  /**
27
20
  * Create a contact
28
- * @example
29
- * execute(
30
- * createContact(data)
31
- * )(state)
21
+ * @example <caption>Create a contact</caption>
22
+ * createContact(data)
32
23
  * @public
33
24
  * @function
34
25
  * @param {object} data - Payload data for the contact
@@ -37,10 +28,8 @@ export function createPayment(data: object): Operation;
37
28
  export function createContact(data: object): Operation;
38
29
  /**
39
30
  * Create a collection request
40
- * @example
41
- * execute(
42
- * createCollectionRequest(data)
43
- * )(state)
31
+ * @example <caption>Create a collection request</caption>
32
+ * createCollectionRequest(data)
44
33
  * @public
45
34
  * @function
46
35
  * @param {object} data - Payload data for the collection request