Sample added

.gitignore

@@ -177,4 +177,5 @@ dist
 
 # End of https://www.toptal.com/developers/gitignore/api/node,macos
 test/credentials*.json
+credentials*.json
 test/*.xml

docs/README.md

@@ -5,4 +5,20 @@
 | `getActivity`| https://docs.oracle.com/en/cloud/saas/field-service/cxfsc/op-rest-ofsccore-v1-activities-activityid-get.html |
 | `updateActivity`| https://docs.oracle.com/en/cloud/saas/field-service/cxfsc/op-rest-ofsccore-v1-activities-activityid-patch.html
 | `getSubscriptions` | https://docs.oracle.com/en/cloud/saas/field-service/cxfsc/op-rest-ofsccore-v1-events-subscriptions-get.html
-| `importPlugins` | https://docs.oracle.com/en/cloud/saas/field-service/cxfsc/op-rest-ofscmetadata-v1-plugins-custom-actions-import-post.html
+| `importPlugins` | https://docs.oracle.com/en/cloud/saas/field-service/cxfsc/op-rest-ofscmetadata-v1-plugins-custom-actions-import-post.html
+
+## Sample
+
+1. Generate the javascript version of the module (`npm run dist`). A new folder called `dist` will be created, containing a javascript module (`ofs.es.js`)
+2. Create in the same folder as the sample a file called `credentials_sample.json` with the following content, replacing the placeholders by your own environment data:
+```
+{
+ "instance": "<YOUR OFS INSTANCE NAME>",
+ "clientId": "<YOUR APPLICATION CLIENT ID>",
+ "clientSecret": "<YOUR APPLICATION CLIENT SECRET>"
+}
+```
+3. Run the sample. The output should be a list of the active event subscriptions in your environment
+```
+node sample.js
+```

docs/sample/sample.js

@@ -0,0 +1,12 @@
+/*
+ * Copyright © 2023, Oracle and/or its affiliates.
+ * Licensed under the Universal Permissive License (UPL), Version 1.0 as shown at https://oss.oracle.com/licenses/upl/
+ */
+
+import { OFS } from "../../dist/ofs.es.js";
+import myCredentials from "./credentials_sample.json" assert { type: "json" };
+
+// Get the list of active subscriptions
+const myProxy = new OFS(myCredentials);
+const result = await myProxy.getSubscriptions();
+console.log(result.data);

package.json

@@ -14,7 +14,6 @@
  "url": "https://github.com/oracle/ofs-js"
  },
  "scripts": {
- "prepare": "tsc",
  "build": "tsc",
  "start": "ts-node src/index.ts",
  "test": "jest",