npm - @pitcher/js-api - Versions diffs - 1.24.0-beta.2 → 1.24.0-rc.0 - Mend

@pitcher/js-api 1.24.0-beta.2 → 1.24.0-rc.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.

Files changed (491) hide show

package/README.md CHANGED Viewed

@@ -11,9 +11,9 @@ This is the JavaScript API to interact with the data layer of the NG platform.
 <html>
   <head>
     <title>My app</title>
-    <script src="https://unpkg.com/@pitcher/js-api"></script>
+    <script src="https://cdn.jsdelivr.net/npm/@pitcher/js-api"></script>
     <!-- or for beta: -->
-    <!-- <script src="https://unpkg.com/@pitcher/js-api@beta"></script> -->
+    <!-- <script src="https://cdn.jsdelivr.net/npm/@pitcher/js-api@beta"></script> -->
   </head>
   <body>
     <script>
@@ -31,7 +31,7 @@ This is the JavaScript API to interact with the data layer of the NG platform.
 For more details, please visit the [documentation](https://pitcherag.github.io/canvas-ui).
-## Beta deployment
+## Beta npm tag publish
 1. Go to `canvas-ui` folder
 2. Edit `src/assets/jsApiAssets/package.json` and change version in the file to beta eg. `1.0.0-beta.0`

package/impact-js-api.spec.json ADDED Viewed

@@ -0,0 +1,212 @@
+{
+  "version": "19.139.0",
+  "methods": {
+    "on": {
+      "description": "Subscribe to a given event type by its key."
+    },
+    "off": {
+      "description": "Unsubscribe from a given event type by its key and the attached callback reference."
+    },
+    "enter_fullscreen": {
+      "description": "Make the entire CatalogIQ fullscreen."
+    },
+    "exit_fullscreen": {
+      "description": "Exit fullscreen mode."
+    },
+    "is_fullscreen": {
+      "description": "Return is CatalogIQ in fullscreen."
+    },
+    "logout": {
+      "description": "Log out the current user."
+    },
+    "quit_instance": {
+      "description": "Quit the current instance and go to the instance selection screen."
+    },
+    "get_request_types": {
+      "description": "Get the request types."
+    },
+    "broadcast": {
+      "description": "Broadcast an event to CatalogIQ."
+    },
+    "subscribe": {
+      "description": "Subscribe to updates."
+    },
+    "unsubscribe": {
+      "description": "Unsubscribe from updates."
+    },
+    "get_canvases": {
+      "description": "Fetches a list of canvases to use in your app."
+    },
+    "create_canvas": {
+      "description": ""
+    },
+    "delete_canvas": {
+      "description": ""
+    },
+    "update_canvas": {
+      "description": "Updates a canvas by ID"
+    },
+    "update_canvas_indicators": {
+      "description": "Updates canvas indicators by canvas ID. It merges the passed object into existing canvas indicators adding new keys if they were empty and overriding pre-existing keys."
+    },
+    "get_canvas": {
+      "description": ""
+    },
+    "share_canvas": {
+      "description": ""
+    },
+    "get_canvas_recommended_files": {
+      "description": ""
+    },
+    "get_canvas_theme": {
+      "description": ""
+    },
+    "unassign_canvas_theme": {
+      "description": ""
+    },
+    "get_env": {
+      "description": "Fetches the necessary info for the app to know where it is embedded."
+    },
+    "update_my_user": {
+      "description": ""
+    },
+    "get_events": {
+      "description": ""
+    },
+    "create_event": {
+      "description": ""
+    },
+    "update_event": {
+      "description": ""
+    },
+    "delete_event": {
+      "description": ""
+    },
+    "get_favorites": {
+      "description": "Get a list of favorites"
+    },
+    "create_favorite": {
+      "description": "Create a favorite"
+    },
+    "delete_favorite": {
+      "description": "Delete a favorite"
+    },
+    "submit_user_feedback": {
+      "description": "Submit user feedback"
+    },
+    "get_files": {
+      "description": ""
+    },
+    "get_recent_files": {
+      "description": ""
+    },
+    "download_file": {
+      "description": ""
+    },
+    "get_app_config": {
+      "description": ""
+    },
+    "get_file": {
+      "description": ""
+    },
+    "get_file_revision_data": {
+      "description": ""
+    },
+    "update_file": {
+      "description": ""
+    },
+    "delete_file": {
+      "description": ""
+    },
+    "create_file": {
+      "description": ""
+    },
+    "select_device_file": {
+      "description": "Dispatches iOS native file selector and returns the selected file."
+    },
+    "get_file_revisions": {
+      "description": ""
+    },
+    "get_core_folders": {
+      "description": ""
+    },
+    "patch_core_folder": {
+      "description": ""
+    },
+    "get_folder": {
+      "description": "Retrieves a folder by its ID."
+    },
+    "create_folder": {
+      "description": "Creates a new folder."
+    },
+    "update_folder": {
+      "description": "Updates an existing folder."
+    },
+    "delete_folder": {
+      "description": "Deletes a folder."
+    },
+    "move_folder_items": {
+      "description": "Moves items (files or folders) to a target folder."
+    },
+    "get_languages": {
+      "description": "Fetches available languages for the logged-in user"
+    },
+    "get_instance_metadata_templates": {
+      "description": ""
+    },
+    "notify": {
+      "description": ""
+    },
+    "open": {
+      "description": "Open a file in the CatalogIQ instance."
+    },
+    "open_external_url": {
+      "description": "Open external URL in a new tab. Works on both web and mobile."
+    },
+    "fetch_document_info": {
+      "description": ""
+    },
+    "render_page_as_image": {
+      "description": "Renders a page from a file together with annotations."
+    },
+    "query": {
+      "description": ""
+    },
+    "search": {
+      "description": ""
+    },
+    "share": {
+      "description": "Dispatch iOS sharing dialog."
+    },
+    "trigger_non_files_sync": {
+      "description": "Dispatches iOS only sync method for non-files."
+    },
+    "get_themes": {
+      "description": ""
+    },
+    "assign_canvas_theme": {
+      "description": ""
+    },
+    "toast": {
+      "description": ""
+    },
+    "track": {
+      "description": ""
+    },
+    "get_users": {
+      "description": ""
+    },
+    "refresh_service_token": {
+      "description": "Ask for a refreshed Salesforce token. In case the token hasn't expired yet, this method will return the same token as the current one found in the (`getEnv`)[#getenv] result."
+    },
+    "refresh_access_token": {
+      "description": ""
+    },
+    "close": {
+      "description": ""
+    },
+    "open_web_view_always_on_top": {
+      "description": ""
+    }
+  }
+}