@flipdish/authorization 0.0.1-rc.1756734343

package/.openapi-generator/FILES

@@ -0,0 +1,12 @@
+.gitignore
+.npmignore
+.openapi-generator-ignore
+README.md
+api.ts
+base.ts
+common.ts
+configuration.ts
+git_push.sh
+index.ts
+package.json
+tsconfig.json

package/.openapi-generator/VERSION

@@ -0,0 +1 @@
+7.8.0

package/.openapi-generator-ignore

@@ -0,0 +1,23 @@
+# OpenAPI Generator Ignore
+# Generated by openapi-generator https://github.com/openapitools/openapi-generator
+
+# Use this file to prevent files from being overwritten by the generator.
+# The patterns follow closely to .gitignore or .dockerignore.
+
+# As an example, the C# client generator defines ApiClient.cs.
+# You can make changes and tell OpenAPI Generator to ignore just this file by uncommenting the following line:
+#ApiClient.cs
+
+# You can match any string of characters against a directory, file or extension with a single asterisk (*):
+#foo/*/qux
+# The above matches foo/bar/qux and foo/baz/qux, but not foo/bar/baz/qux
+
+# You can recursively match patterns against a directory, file or extension with a double asterisk (**):
+#foo/**/qux
+# This matches foo/bar/qux, foo/baz/qux, and foo/bar/baz/qux
+
+# You can also negate patterns with an exclamation (!).
+# For example, you can ignore all files in a docs folder with the file extension .md:
+#docs/*.md
+# Then explicitly reverse the ignore rule for a single file:
+#!docs/README.md

package/README.md

@@ -0,0 +1,138 @@
+## @flipdish/authorization
+
+This package provides a Typescript/JavaScript client for interacting with Flipdish's Authorization APIs over HTTP.
+
+Internally the package utilizes the [axios](https://github.com/axios/axios) as its HTTP client. 
+
+### Example code
+
+```typescript
+import { AuthorizationApi, Configuration, PermissionsApi, Permissions } from '@flipdish/authorization';
+import { describe, expect, test, it } from '@jest/globals';
+
+const basePath = "https://api.flipdish.co/auth/";
+const configuration = new Configuration({
+    basePath,
+    // to get the API key, you should follow these docs: 
+    // https://developers.flipdish.com/docs/getting-started
+    accessToken: process.env.FLIPDISH_BEARER_TOKEN_PROD,
+    // if using in a browser set useDefaultUserAgent 
+    // to true to prevent errors
+    // useDefaultUserAgent: true
+});
+
+const authorization = new AuthorizationApi(configuration);
+const permissions = new PermissionsApi(configuration);
+
+describe('Authorization Tests', () => {
+    describe('Authorization', () => {
+
+        test('List Permissions', async () => {
+            const permissionsResponse = await permissions.listPermissions();
+            expect(permissionsResponse.status).toBe(200);
+            expect(permissionsResponse.data.permissions).toBeDefined();
+            expect(permissionsResponse.data.permissions.length).toBeGreaterThan(0);
+            expect(permissionsResponse.data.permissions).toContain(Permissions.ViewApp);
+            expect(permissionsResponse.data.permissions).toContain(Permissions.CreateApp);
+            expect(permissionsResponse.data.permissions).toContain(Permissions.UpdateApp);
+            expect(permissionsResponse.data.permissions).toContain(Permissions.ViewAppName);
+            expect(permissionsResponse.data.permissions).toContain(Permissions.EditAppAssets);
+        });
+
+        describe('Authenticate and Authorize', () => {
+            it('should authenticate and authorize with a valid FD-Authorization cookie', async () => {
+                const authorizationResponse = await authorization.authenticateAndAuthorize({
+                    headers: {
+                        'Cookie': `FD-Authorization=${process.env.FD_AUTH_COOKIE_PROD};`,
+                    },
+                    action: Permissions.AnyAuditLogs,
+                    resource: {
+                        id: "org12345",
+                        type: "Org",
+                    }
+                });
+
+                expect(authorizationResponse.status).toBe(200);
+                expect(authorizationResponse.data.authentication.authenticated).toBe(true);
+                expect(authorizationResponse.data.authentication.principal?.type).toBe("User");
+                expect(authorizationResponse.data.authentication.principal?.id).toBe("8147747");
+            });
+
+            it('should not authenticate and authorize with an invalid FD-Authorization cookie', async () => {
+                try {
+                    await authorization.authenticateAndAuthorize({
+                        headers: {
+                            'Cookie': `FD-Authorization=not-a-valid-cookie;`,
+                        },
+                        action: Permissions.AnyAuditLogs,
+                        resource: {
+                            id: "org12345",
+                            type: "Org",
+                        },
+                    });
+                } catch (error: any) {
+                    expect(error.response.status).toBe(401);
+                    expect(error.response.data.message).toBe("Unauthenticated");
+                }
+            });
+
+            it('should authenticate and authorize with a valid Bearer token', async () => {
+                const authorizationResponse = await authorization.authenticateAndAuthorize({
+                    headers: {
+                        'Authorization': `Bearer ${process.env.FLIPDISH_BEARER_TOKEN_PROD}`,
+                    },
+                    action: Permissions.AnyAuditLogs,
+                    resource: {
+                        id: "org12345",
+                        type: "Org",
+                    }
+                });
+
+                expect(authorizationResponse.status).toBe(200);
+                expect(authorizationResponse.data.authentication.authenticated).toBe(true);
+                expect(authorizationResponse.data.authentication.principal?.type).toBe("User");
+                expect(authorizationResponse.data.authentication.principal?.id).toBe("8147747");
+            });
+        });
+
+
+        test('Authorize', async () => {
+            let testPrincipal: any = {
+                id: "12345",
+                type: "User",
+            };
+
+            let testResource: any = {
+                id: "org12345",
+                type: "Org",
+            };
+
+            const authorizationResponse = await authorization.authorize({
+                principal: testPrincipal,
+                action: Permissions.AnyAuditLogs,
+                resource: testResource
+            });
+            expect(authorizationResponse.status).toBe(200);
+            expect(authorizationResponse.data.allowed).toBe(false);
+            expect(authorizationResponse.data.decision).toBe("DENY");
+        });
+    });
+});
+```
+
+The generated Node module can be used in the following environments:
+
+Environment
+* Node.js
+* Webpack
+* Browserify
+
+Language level
+* ES5 - you must have a Promises/A+ library installed
+* ES6
+
+Module system
+* CommonJS
+* ES6 module system
+
+It can be used in both TypeScript and JavaScript. In TypeScript, the definition will be automatically resolved via `package.json`. ([Reference](https://www.typescriptlang.org/docs/handbook/declaration-files/consumption.html))