From 16e6fc5969425086d08228451d5c5bfa6bd80243 Mon Sep 17 00:00:00 2001 From: StormGear Date: Mon, 6 Jan 2025 15:07:41 +0000 Subject: [PATCH] added CHANGELOG, LICENSE, and README to the insomnia package --- packages/insomnia/CHANGELOG.md | 3 + packages/insomnia/LICENSE | 201 +++++++++++++++++ packages/insomnia/README.md | 396 +++++++++++++++++++++++++++++++++ packages/insomnia/pubspec.yaml | 29 +++ pubspec.lock | 15 ++ 5 files changed, 644 insertions(+) create mode 100644 packages/insomnia/CHANGELOG.md create mode 100644 packages/insomnia/LICENSE create mode 100644 packages/insomnia/README.md create mode 100644 packages/insomnia/pubspec.yaml diff --git a/packages/insomnia/CHANGELOG.md b/packages/insomnia/CHANGELOG.md new file mode 100644 index 00000000..a0ba62dd --- /dev/null +++ b/packages/insomnia/CHANGELOG.md @@ -0,0 +1,3 @@ +## 0.0.1 + +- Implement fromJson object and fromJson String for Insomnia v4 json format diff --git a/packages/insomnia/LICENSE b/packages/insomnia/LICENSE new file mode 100644 index 00000000..498fbbb0 --- /dev/null +++ b/packages/insomnia/LICENSE @@ -0,0 +1,201 @@ + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "[]" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright 2023 Ashita Prasad, Ankit Mahato + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. diff --git a/packages/insomnia/README.md b/packages/insomnia/README.md new file mode 100644 index 00000000..7681aa56 --- /dev/null +++ b/packages/insomnia/README.md @@ -0,0 +1,396 @@ +# insomnia + +Seamlessly convert Insomnia Collection Format v4 to Dart. + +Helps you bring your APIs stored in Insomnia to Dart and work with them. + +Currently, this package is being used by [API Dash](https://github.com/foss42/apidash), a beautiful open-source cross-platform (macOS, Windows, Linux, Android & iOS) API Client built using Flutter which can help you easily create & customize your API requests, visually inspect responses and generate API integration code. A lightweight alternative to postman & insomnia. + +## Usage + +### Example 1: Insomnia collection JSON string to Insomnia model + +```dart +import 'package:insomnia/insomnia.dart'; + +void main() { + // Example 1: Insomnia collection JSON string to Insomnia model + var collectionJsonStr = r''' +{ + "_type": "export", + "__export_format": 4, + "__export_date": "2025-01-05T13:05:11.752Z", + "__export_source": "insomnia.desktop.app:v10.3.0", + "resources": [ + { + "_id":"req_15f4d64ca3084a92a0680e29a958c9da", + "parentId":"fld_a2e9704c49034e36a05cdb3a233f6ebd", + "modified":1736112258432, + "created":1736111908438, + "url":"https://food-service-backend.onrender.com/api/users/", + "name":"get-with-params", + "description":"", + "method":"GET", + "body":{}, + "parameters": [ + {"id":"pair_bf0ae4f4280e440a8a591b64fd4ec4f4","name":"user_id","value":"34","description":"","disabled":false} + ], + "headers":[{"name":"User-Agent","value":"insomnia/10.3.0"}], + "authentication":{}, + "metaSortKey":-1736111908438, + "isPrivate":false, + "pathParameters":[], + "settingStoreCookies":true, + "settingSendCookies":true, + "settingDisableRenderRequestBody":false, + "settingEncodeUrl":true, + "settingRebuildPath":true, + "settingFollowRedirects": "global", + "_type":"request" + }, + { + "_id":"fld_a2e9704c49034e36a05cdb3a233f6ebd", + "parentId":"wrk_fde7dcc4f5064b74b0fd749cbf8f684a", + "modified":1736082089076, + "created":1736082089076, + "name":"APIDash-APItests", + "description":"These are test endpoints for API Dash", + "environment":{},"environmentPropertyOrder":null, + "metaSortKey":-1736082080559, + "preRequestScript":"", + "afterResponseScript":"", + "authentication":{}, + "_type":"request_group" + }, + {"_id":"wrk_fde7dcc4f5064b74b0fd749cbf8f684a", + "parentId":null, + "modified":1736082089075, + "created":1736082089075, + "name":"APIDash-APItests","description":"", + "scope":"collection","_type":"workspace"}, + { + "_id":"req_db3c393084f14369bb409afe857e390c", + "parentId":"fld_a2e9704c49034e36a05cdb3a233f6ebd", + "modified":1736082089077, + "created":1736082089077, + "url":"https://api.apidash.dev/country/codes", + "name":"test-get", + "description":"", + "method":"GET", + "body":{}, + "parameters":[], + "headers":[], + "authentication":{}, + "preRequestScript":"", + "metaSortKey":-1736082080558, + "isPrivate":false, + "afterResponseScript":"", + "settingStoreCookies":true, + "settingSendCookies":true, + "settingDisableRenderRequestBody":false, + "settingEncodeUrl":true, + "settingRebuildPath":true, + "settingFollowRedirects":"global", + "_type":"request"}, + {"_id":"req_ba718bbacd094e95a30ef3f07baa4e42", + "parentId":"fld_a2e9704c49034e36a05cdb3a233f6ebd", + "modified":1736082089078,"created":1736082089078, + "url":"https://api.apidash.dev/case/lower", + "name":"test-post", + "description":"", + "method":"POST", + "body":{"mimeType":"application/json","text":"{\n \"text\": \"Grass is green\"\n}"}, + "parameters":[], + "headers":[{"name":"Content-Type","value":"application/json"}], + "authentication":{}, + "preRequestScript":"", + "metaSortKey":-1736082080557, + "isPrivate":false, + "afterResponseScript":"", + "settingStoreCookies":true, + "settingSendCookies":true, + "settingDisableRenderRequestBody":false, + "settingEncodeUrl":true, + "settingRebuildPath":true, + "settingFollowRedirects":"global", + "_type":"request"}, + {"_id":"req_24cff90fc3c74e71a567f61d3f8e8cc1", + "parentId":"fld_a2e9704c49034e36a05cdb3a233f6ebd", + "modified":1736082089078, + "created":1736082089078, + "url":"https://reqres.in/api/users/2", + "name":"test-put", + "description":"", + "method":"PUT", + "body":{"mimeType":"application/json", + "text":"{\n \"name\": \"morpheus\",\n \"job\": \"zion resident\"\n}"}, + "parameters":[], + "headers":[{"name":"Content-Type","value":"application/json"}], + "authentication":{}, + "preRequestScript":"", + "metaSortKey":-1736082080556, + "isPrivate":false, + "afterResponseScript":"", + "settingStoreCookies":true, + "settingSendCookies":true, + "settingDisableRenderRequestBody":false, + "settingEncodeUrl":true, + "settingRebuildPath":true, + "settingFollowRedirects":"global", + "_type":"request"}, + { + "_id":"env_9d818b2866dffc9831640d91a516ea3986e16bda", + "parentId":"wrk_fde7dcc4f5064b74b0fd749cbf8f684a", + "modified":1736082095630,"created":1736082095630, + "name":"Base Environment", + "data":{},"dataPropertyOrder":null, + "color":null, + "isPrivate":false, + "metaSortKey":1736082095630, + "environmentType":"kv", + "_type":"environment" + }, + { + "_id":"jar_9d818b2866dffc9831640d91a516ea3986e16bda", + "parentId":"wrk_fde7dcc4f5064b74b0fd749cbf8f684a", + "modified":1736082095688, + "created":1736082095688, + "name":"Default Jar", + "cookies":[], + "_type":"cookie_jar" + } + ] +} +'''; + + + + var collection; + try { + collection = insomniaCollectionFromJsonStr(collectionJsonStr); + + + + print(collection.exportSource); + // insomnia.desktop.app:v10.3.0 + print(collection.resources?[3].name); + // test-get + print(collection.resources?[3].method); + // GET + print(collection.resources?[3].url); + // https://api.apidash.dev/country/codes + } catch (e) { + print(e.toString() + 'error from collection'); + } +} +``` + +### Example 2: Insomnia collection from JSON + +```dart +import 'package:insomnia/insomnia.dart'; + +void main() { + // Example 2: Insomnia collection from JSON + var collectionJson = { + "_type": "export", + "__export_format": 4, + "__export_date": "2025-01-05T13:05:11.752Z", + "__export_source": "insomnia.desktop.app:v10.3.0", + "resources": [ + { + "_id": "req_15f4d64ca3084a92a0680e29a958c9da", + "parentId": "fld_a2e9704c49034e36a05cdb3a233f6ebd", + "modified": 1736112258432, + "created": 1736111908438, + "url": "https://food-service-backend.onrender.com/api/users/", + "name": "get-with-params", + "description": "", + "method": "GET", + "body": {}, + "parameters": [ + { + "id": "pair_bf0ae4f4280e440a8a591b64fd4ec4f4", + "name": "user_id", + "value": "34", + "description": "", + "disabled": false + } + ], + "headers": [ + {"name": "User-Agent", "value": "insomnia/10.3.0"} + ], + "authentication": {}, + "metaSortKey": -1736111908438, + "isPrivate": false, + "pathParameters": [], + "settingStoreCookies": true, + "settingSendCookies": true, + "settingDisableRenderRequestBody": false, + "settingEncodeUrl": true, + "settingRebuildPath": true, + "settingFollowRedirects": "global", + "_type": "request" + }, + { + "_id": "fld_a2e9704c49034e36a05cdb3a233f6ebd", + "parentId": "wrk_fde7dcc4f5064b74b0fd749cbf8f684a", + "modified": 1736082089076, + "created": 1736082089076, + "name": "APIDash-APItests", + "description": "These are test endpoints for API Dash", + "environment": {}, + "environmentPropertyOrder": null, + "metaSortKey": -1736082080559, + "preRequestScript": "", + "afterResponseScript": "", + "authentication": {}, + "_type": "request_group" + }, + { + "_id": "wrk_fde7dcc4f5064b74b0fd749cbf8f684a", + "parentId": null, + "modified": 1736082089075, + "created": 1736082089075, + "name": "APIDash-APItests", + "description": "", + "scope": "collection", + "_type": "workspace" + }, + { + "_id": "req_db3c393084f14369bb409afe857e390c", + "parentId": "fld_a2e9704c49034e36a05cdb3a233f6ebd", + "modified": 1736082089077, + "created": 1736082089077, + "url": "https://api.apidash.dev/country/codes", + "name": "test-get", + "description": "", + "method": "GET", + "body": {}, + "parameters": [], + "headers": [], + "authentication": {}, + "preRequestScript": "", + "metaSortKey": -1736082080558, + "isPrivate": false, + "afterResponseScript": "", + "settingStoreCookies": true, + "settingSendCookies": true, + "settingDisableRenderRequestBody": false, + "settingEncodeUrl": true, + "settingRebuildPath": true, + "settingFollowRedirects": "global", + "_type": "request" + }, + { + "_id": "req_ba718bbacd094e95a30ef3f07baa4e42", + "parentId": "fld_a2e9704c49034e36a05cdb3a233f6ebd", + "modified": 1736082089078, + "created": 1736082089078, + "url": "https://api.apidash.dev/case/lower", + "name": "test-post", + "description": "", + "method": "POST", + "body": { + "mimeType": "application/json", + "text": "{\n \"text\": \"Grass is green\"\n}" + }, + "parameters": [], + "headers": [ + {"name": "Content-Type", "value": "application/json"} + ], + "authentication": {}, + "preRequestScript": "", + "metaSortKey": -1736082080557, + "isPrivate": false, + "afterResponseScript": "", + "settingStoreCookies": true, + "settingSendCookies": true, + "settingDisableRenderRequestBody": false, + "settingEncodeUrl": true, + "settingRebuildPath": true, + "settingFollowRedirects": "global", + "_type": "request" + }, + { + "_id": "req_24cff90fc3c74e71a567f61d3f8e8cc1", + "parentId": "fld_a2e9704c49034e36a05cdb3a233f6ebd", + "modified": 1736082089078, + "created": 1736082089078, + "url": "https://reqres.in/api/users/2", + "name": "test-put", + "description": "", + "method": "PUT", + "body": { + "mimeType": "application/json", + "text": + "{\n \"name\": \"morpheus\",\n \"job\": \"zion resident\"\n}" + }, + "parameters": [], + "headers": [ + {"name": "Content-Type", "value": "application/json"} + ], + "authentication": {}, + "preRequestScript": "", + "metaSortKey": -1736082080556, + "isPrivate": false, + "afterResponseScript": "", + "settingStoreCookies": true, + "settingSendCookies": true, + "settingDisableRenderRequestBody": false, + "settingEncodeUrl": true, + "settingRebuildPath": true, + "settingFollowRedirects": "global", + "_type": "request" + }, + { + "_id": "env_9d818b2866dffc9831640d91a516ea3986e16bda", + "parentId": "wrk_fde7dcc4f5064b74b0fd749cbf8f684a", + "modified": 1736082095630, + "created": 1736082095630, + "name": "Base Environment", + "data": {}, + "dataPropertyOrder": null, + "color": null, + "isPrivate": false, + "metaSortKey": 1736082095630, + "environmentType": "kv", + "_type": "environment" + }, + { + "_id": "jar_9d818b2866dffc9831640d91a516ea3986e16bda", + "parentId": "wrk_fde7dcc4f5064b74b0fd749cbf8f684a", + "modified": 1736082095688, + "created": 1736082095688, + "name": "Default Jar", + "cookies": [], + "_type": "cookie_jar" + } + ] + }; + + var collection2; + try { + collection2 = InsomniaCollection.fromJson(collectionJson); + print(collection2.exportSource); + // insomnia.desktop.app:v10.3.0 + print(collection2.resources?[3].name); + // test-get + print(collection2.resources?[3].method); + // GET + print(collection2.resources?[3].url); + // https://api.apidash.dev/country/codes + } catch (e) { + print(e.toString() + 'error from collection2'); + } +} +``` + +## Maintainer + +- Ashita Prasad ([GitHub](https://github.com/ashitaprasad), [LinkedIn](https://www.linkedin.com/in/ashitaprasad/), [X](https://x.com/ashitaprasad)) +- Papa Kofi (contributor) ([GitHub](https://github.com/StormGear), [LinkedIn](https://www.linkedin.com/in/papakofiboahen)) + +## License + +This project is licensed under the [Apache License 2.0](https://github.com/foss42/apidash/blob/main/packages/postman/LICENSE). diff --git a/packages/insomnia/pubspec.yaml b/packages/insomnia/pubspec.yaml new file mode 100644 index 00000000..e6bdceef --- /dev/null +++ b/packages/insomnia/pubspec.yaml @@ -0,0 +1,29 @@ +name: insomnia +description: Seamlessly convert Insomnia Collection Format v4 to Dart and vice versa. +version: 0.0.1 +homepage: https://github.com/foss42/apidash + +topics: + - insomnia + - api + - rest + - http + - network + +environment: + sdk: ">=3.0.0 <4.0.0" + +dependencies: + diff_match_patch: ^0.4.1 + equatable: ^2.0.7 + freezed_annotation: ^2.4.4 + json_annotation: ^4.9.0 + +dev_dependencies: + build_runner: ^2.4.13 + freezed: ^2.5.7 + json_serializable: ^6.9.0 + lints: ^4.0.0 + test: ^1.24.0 + + diff --git a/pubspec.lock b/pubspec.lock index ed80a941..9685fca8 100644 --- a/pubspec.lock +++ b/pubspec.lock @@ -339,6 +339,14 @@ packages: url: "https://pub.dev" source: hosted version: "0.4.4" + diff_match_patch: + dependency: transitive + description: + name: diff_match_patch + sha256: "2efc9e6e8f449d0abe15be240e2c2a3bcd977c8d126cfd70598aee60af35c0a4" + url: "https://pub.dev" + source: hosted + version: "0.4.1" equatable: dependency: transitive description: @@ -764,6 +772,13 @@ packages: url: "https://pub.dev" source: hosted version: "4.3.0" + insomnia: + dependency: transitive + description: + path: "packages/insomnia" + relative: true + source: path + version: "0.0.1" integration_test: dependency: "direct dev" description: flutter