@rocket.chat/rest-typings 6.3.0-rc.0

package/CHANGELOG.md

@@ -0,0 +1,29 @@
+# @rocket.chat/rest-typings
+
+## 6.3.0-rc.0
+
+### Minor Changes
+
+- 74aa677088: feat: Add custom OAuth setting to allow merging users to others from distinct services
+- e846d873b7: feat: Introduce Feature Preview page
+- 0645f42e12: Reintroduce an user preference to allow users to see all thread messages in the main channel
+
+### Patch Changes
+
+- e14ec50816: Added and Improved Custom Fields form to Registration Flow
+- e006013e5f: chore: New Livechat SDK Implementation
+- eecd9fc99a: fix: Omnichannel Tags available to be used in the wrong department
+- 6a474ff952: Refactored Omnichannel department pages to use best practices, also fixed existing bugs
+- 9da856cc67: fix: Resume on-hold chat not working with max-chat's allowed per agent config
+- 12d97e16c2: feat: Allow Incoming Webhooks to override destination channel
+- Updated dependencies [e14ec50816]
+- Updated dependencies [9da856cc67]
+- Updated dependencies [12d97e16c2]
+  - @rocket.chat/core-typings@6.3.0-rc.0
+
+## 6.2.6
+
+### Patch Changes
+
+- Updated dependencies []:
+  - @rocket.chat/core-typings@6.2.6

package/README.md

@@ -0,0 +1,85 @@
+
+#  @rocket.chat/rest-typings
+
+Package containing all Rocket.Chat rest endpoint definitions
+
+
+## Contributing
+
+Contributions are always welcome!
+However we have some recommendations.
+- Check if your implementation matches your definitions, a bad definition is worse than none.
+- Use the generic types we created for paging.
+- Create functions that assert properties (very useful for the backend)
+- Do tests to ensure that your assertions are correct.
+- Avoid incomplete and unknow typings
+
+### Good examples of what not to do:
+
+#### If you have an endpoint that accepts name or id, both are not optional, one of them is required
+
+```typescript
+    
+    type EndPointTestGetParams = { name?: string; id?: string; } // WRONG!
+
+    type EndPointTestGetParams = { name: string; } | { id: string; } // Better :)
+````
+
+#### If you have an endpoint that accepts name or id, both are not optional, one of them is required
+
+```typescript
+    export const isEndPointTestGetParams = (props: any) is EndPointTestGetParams => 'name' in prop || 'id' in prop; // WRONG!
+
+    // .... Better
+    
+    
+    import Ajv from 'ajv';
+
+    const ajv = new Ajv();
+    const endPointTestGetParams = {
+        oneOf: [
+            {
+                type: 'object',
+                properties: {
+                    name: {
+                        type: 'string',
+                    },
+                },
+                required: ['name'],
+                additionalProperties: false,
+            },
+            {
+                type: 'object',
+                properties: {
+                    id: {
+                        type: 'string',
+                    },
+                },
+                required: ['id'],
+                additionalProperties: false,
+            },
+        ],
+    };
+
+    export const isEndPointTestGetParams = ajv.compile<EndPointTestGetParams>(endPointTestGetParams);
+```
+## Optimizations
+
+we use interfaces to register endpoints, so if you use a custom version, or miss an endpoint, you don't necessarily need to recompile the code, you can do it in your own code
+
+```typescript
+    declare module '@rocket.chat/rest-typings' {
+        interface Endpoints {
+            'custom/endpoint': {
+                GET: (params: PaginatedRequest<{ query: string }>) => PaginatedResult<{
+                    some: string[];
+                }>;
+            };
+        }
+    }
+```
+
+## License
+
+MIT
+

package/package.json

@@ -0,0 +1,37 @@
+{
+  "name": "@rocket.chat/rest-typings",
+  "version": "6.3.0-rc.0",
+  "devDependencies": {
+    "@rocket.chat/eslint-config": "^0.5.0",
+    "@types/jest": "~29.5.2",
+    "eslint": "~8.43.0",
+    "jest": "~29.5.0",
+    "jest-environment-jsdom": "~29.5.0",
+    "mongodb": "^4.12.1",
+    "ts-jest": "~29.0.5",
+    "typescript": "~5.1.3"
+  },
+  "scripts": {
+    "lint": "eslint --ext .js,.jsx,.ts,.tsx .",
+    "lint:fix": "eslint --ext .js,.jsx,.ts,.tsx . --fix",
+    "test": "jest",
+    "dev": "tsc --watch --preserveWatchOutput -p tsconfig.json",
+    "build": "rm -rf dist && tsc -p tsconfig.json"
+  },
+  "main": "./dist/index.js",
+  "typings": "./dist/index.d.ts",
+  "files": [
+    "/dist"
+  ],
+  "dependencies": {
+    "@rocket.chat/apps-engine": "1.39.1",
+    "@rocket.chat/core-typings": "^6.3.0-rc.0",
+    "@rocket.chat/message-parser": "next",
+    "@rocket.chat/ui-kit": "next",
+    "ajv": "^8.11.0",
+    "ajv-formats": "^2.1.1"
+  },
+  "volta": {
+    "extends": "../../package.json"
+  }
+}