monday-sdk-js 0.5.6 → 0.5.7

package/README.md

@@ -4,6 +4,7 @@
 # monday.com Apps framework SDK for JavaScript
 [![GitHub license](https://img.shields.io/badge/license-MIT-blue.svg)](https://github.com/mondaycom/monday-sdk-js/blob/master/LICENSE)   [![npm version](https://img.shields.io/npm/v/monday-sdk-js.svg?style=flat)](https://www.npmjs.com/package/monday-sdk-js)   [![npm](https://img.shields.io/npm/dm/monday-sdk-js)](https://www.npmjs.com/package/monday-sdk-js)   [![jsDelivr hits (npm)](https://img.shields.io/jsdelivr/npm/hm/monday-sdk-js)](https://www.jsdelivr.com/package/npm/monday-sdk-js)
 
+> **⚠️ DEPRECATION NOTICE:** The **server SDK** in this package is deprecated and will be removed in version **1.0.0**. This package will become **client-side only**. For server-side GraphQL queries (the `api()` method), please migrate to the official [@mondaydotcomorg/api](https://www.npmjs.com/package/@mondaydotcomorg/api) package.
 
 The monday.com SDK provides a toolset for application developers to build features and solutions on top of the monday.com Work OS platform. You'll find this SDK useful if you want to:
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "monday-sdk-js",
-  "version": "0.5.6",
+  "version": "0.5.7",
   "private": false,
   "repository": "https://github.com/mondaycom/monday-sdk-js",
   "main": "src/index.js",

package/src/server.js

@@ -6,6 +6,12 @@ const TOKEN_MISSING_ERROR = "Should send 'token' as an option or call mondaySdk.
 
 class MondayServerSdk {
   constructor(options = {}) {
+    console.warn(
+      "[DEPRECATION WARNING] The monday-sdk-js server SDK is deprecated and will be removed in version 1.0.0.\n" +
+        "The 'api()' method for GraphQL queries should be replaced with the official @mondaydotcomorg/api package: https://www.npmjs.com/package/@mondaydotcomorg/api\n" +
+        "For more information, visit: https://developer.monday.com/api-reference/docs/api-sdk"
+    );
+
     this._token = options.token;
     this._apiVersion = options.apiVersion;
 

package/types/client-context.type.ts

@@ -37,6 +37,37 @@ export type Permissions = {
   requiredScopes: string[];
 };
 
+export type AppSubscription = {
+  /**
+   * The billing period frequency: monthly or yearly
+   */
+  billing_period: "yearly" | "monthly";
+  /**
+   * The number of days left until the subscription ends
+   */
+  days_left: number;
+  /**
+   * Returns true if it is still a trial subscription
+   */
+  is_trial: boolean;
+  /**
+   * The maximum number of seats allowed for seat-based plans. Returns null for feature-based plans
+   */
+  max_units: number | null;
+  /**
+   * The subscription plan ID from the app's side
+   */
+  plan_id: string;
+  /**
+   * The subscription's pricing version
+   */
+  pricing_version: number;
+  /**
+   * The date when the subscription renews, in ISO 8601 format
+   */
+  renewal_date: string;
+};
+
 export type BaseContext = {
   themeConfig?: Theme;
   theme: string;
@@ -46,6 +77,7 @@ export type BaseContext = {
   app: App;
   appVersion: AppVersion;
   permissions: Permissions;
+  subscription?: AppSubscription;
 };
 
 export type AppFeatureBoardViewContext = BaseContext & {

package/types/client-data.interface.ts

@@ -147,8 +147,9 @@ export interface ClientData {
      * @param {any} value - The value to store
      * @param {object=} options
      * @param {string=} options.previous_version - Use the new version of the storage (instance-less)
+     * @param {number=} options.ttl - The time to live of the item in seconds
      */
-    setItem(key: string, value: any, options?: { previous_version?: string }): Promise<SetResponse>;
+    setItem(key: string, value: any, options?: { previous_version?: string, ttl?: number }): Promise<SetResponse>;
     /***
      * The instance storage is a key-value database that is scoped to a specific app instance.
      * **Does not work** for instance-less apps.

package/types/server-sdk.interface.ts

@@ -1,5 +1,10 @@
 import { APIOptions } from './client-api.interface';
 
+/**
+ * @deprecated The monday-sdk-js server SDK is deprecated and will be removed in version 1.0.0.
+ * The api() method for GraphQL queries should be replaced with @mondaydotcomorg/api: https://www.npmjs.com/package/@mondaydotcomorg/api
+ * For more information, visit: https://developer.monday.com/api-reference/docs/api-sdk
+ */
 export interface MondayServerSdk {
     setToken(token: string): void;