@digital8/laravel-auth-template-ts-sdk 0.0.8 → 0.0.9

package/.openapi-generator/FILES

@@ -2,27 +2,6 @@
 .npmignore
 .openapi-generator-ignore
 README.md
-docs/AssetFileForUploadResource.md
-docs/AssetFileForUploadResourceArrayResponse.md
-docs/AssetLiteResource.md
-docs/AssetLiteResourceArrayResponse.md
-docs/AssetResource.md
-docs/AssetResourceArrayResponse.md
-docs/GeneralApi.md
-docs/GenericResponse.md
-docs/IndexUserRequest.md
-docs/LoginAuthRequest.md
-docs/PaginatedUserResourceResponse.md
-docs/PagingMetadata.md
-docs/ResetPasswordAuthRequest.md
-docs/SendForgotPasswordLinkAuthRequest.md
-docs/StoreAssetFileRequest.md
-docs/StoreUserRequest.md
-docs/UpdateUserRequest.md
-docs/UserAuthTokenResource.md
-docs/UserAuthTokenResourceArrayResponse.md
-docs/UserResource.md
-docs/UserResourceArrayResponse.md
 package.json
 src/apis/GeneralApi.ts
 src/apis/index.ts

package/.openapi-generator/VERSION

@@ -1 +1 @@
-7.18.0
+7.14.0

package/README.md

@@ -1,139 +1,46 @@
-# @digital8/laravel-auth-template-ts-sdk@0.0.8
+## @digital8/laravel-auth-template-ts-sdk@0.0.9
 
-A TypeScript SDK client for the localhost API.
+This generator creates TypeScript/JavaScript client that utilizes [Fetch API](https://fetch.spec.whatwg.org/). The generated Node module can be used in the following environments:
 
-## Usage
+Environment
+* Node.js
+* Webpack
+* Browserify
 
-First, install the SDK from npm.
+Language level
+* ES5 - you must have a Promises/A+ library installed
+* ES6
 
-```bash
-npm install @digital8/laravel-auth-template-ts-sdk --save
-```
-
-Next, try it out.
-
-
-```ts
-import {
-  Configuration,
-  GeneralApi,
-} from '@digital8/laravel-auth-template-ts-sdk';
-import type { DestroyUserRequest } from '@digital8/laravel-auth-template-ts-sdk';
-
-async function example() {
-  console.log("🚀 Testing @digital8/laravel-auth-template-ts-sdk SDK...");
-  const api = new GeneralApi();
-
-  const body = {
-    // number | The id of the user
-    user: 56,
-  } satisfies DestroyUserRequest;
-
-  try {
-    const data = await api.destroyUser(body);
-    console.log(data);
-  } catch (error) {
-    console.error(error);
-  }
-}
-
-// Run the test
-example().catch(console.error);
-```
-
-
-## Documentation
-
-### API Endpoints
-
-All URIs are relative to *http://localhost/api*
-
-| Class | Method | HTTP request | Description
-| ----- | ------ | ------------ | -------------
-*GeneralApi* | [**destroyUser**](docs/GeneralApi.md#destroyuser) | **POST** /api/users/{user}/delete | Auto-generated: destroyUser
-*GeneralApi* | [**indexUser**](docs/GeneralApi.md#indexuseroperation) | **POST** /api/users/search | Auto-generated: indexUser
-*GeneralApi* | [**loginAuth**](docs/GeneralApi.md#loginauthoperation) | **POST** /api/auth/login | Auto-generated: loginAuth
-*GeneralApi* | [**logoutAuth**](docs/GeneralApi.md#logoutauth) | **POST** /api/auth/logout | Auto-generated: logoutAuth
-*GeneralApi* | [**resetPasswordAuth**](docs/GeneralApi.md#resetpasswordauthoperation) | **POST** /api/auth/reset-password | Auto-generated: resetPasswordAuth
-*GeneralApi* | [**sendForgotPasswordLinkAuth**](docs/GeneralApi.md#sendforgotpasswordlinkauthoperation) | **POST** /api/auth/forgot-password | Auto-generated: sendForgotPasswordLinkAuth
-*GeneralApi* | [**storeAssetFile**](docs/GeneralApi.md#storeassetfileoperation) | **POST** /api/assets/file | Auto-generated: storeAssetFile
-*GeneralApi* | [**storeUser**](docs/GeneralApi.md#storeuseroperation) | **POST** /api/auth/register | Auto-generated: storeUser
-*GeneralApi* | [**updateUser**](docs/GeneralApi.md#updateuseroperation) | **POST** /api/users/{user}/update | Auto-generated: updateUser
-
-
-### Models
-
-- [AssetFileForUploadResource](docs/AssetFileForUploadResource.md)
-- [AssetFileForUploadResourceArrayResponse](docs/AssetFileForUploadResourceArrayResponse.md)
-- [AssetLiteResource](docs/AssetLiteResource.md)
-- [AssetLiteResourceArrayResponse](docs/AssetLiteResourceArrayResponse.md)
-- [AssetResource](docs/AssetResource.md)
-- [AssetResourceArrayResponse](docs/AssetResourceArrayResponse.md)
-- [GenericResponse](docs/GenericResponse.md)
-- [IndexUserRequest](docs/IndexUserRequest.md)
-- [LoginAuthRequest](docs/LoginAuthRequest.md)
-- [PaginatedUserResourceResponse](docs/PaginatedUserResourceResponse.md)
-- [PagingMetadata](docs/PagingMetadata.md)
-- [ResetPasswordAuthRequest](docs/ResetPasswordAuthRequest.md)
-- [SendForgotPasswordLinkAuthRequest](docs/SendForgotPasswordLinkAuthRequest.md)
-- [StoreAssetFileRequest](docs/StoreAssetFileRequest.md)
-- [StoreUserRequest](docs/StoreUserRequest.md)
-- [UpdateUserRequest](docs/UpdateUserRequest.md)
-- [UserAuthTokenResource](docs/UserAuthTokenResource.md)
-- [UserAuthTokenResourceArrayResponse](docs/UserAuthTokenResourceArrayResponse.md)
-- [UserResource](docs/UserResource.md)
-- [UserResourceArrayResponse](docs/UserResourceArrayResponse.md)
+Module system
+* CommonJS
+* ES6 module system
 
-### Authorization
-
-Endpoints do not require authorization.
-
-
-## About
-
-This TypeScript SDK client supports the [Fetch API](https://fetch.spec.whatwg.org/)
-and is automatically generated by the
-[OpenAPI Generator](https://openapi-generator.tech) project:
-
-- API version: `1.0.0`
-- Package version: `0.0.8`
-- Generator version: `7.18.0`
-- Build package: `org.openapitools.codegen.languages.TypeScriptFetchClientCodegen`
-
-The generated npm module supports the following:
-
-- Environments
-  * Node.js
-  * Webpack
-  * Browserify
-- Language levels
-  * ES5 - you must have a Promises/A+ library installed
-  * ES6
-- Module systems
-  * CommonJS
-  * ES6 module system
-
-
-## Development
+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))
 
 ### Building
 
-To build the TypeScript source code, you need to have Node.js and npm installed.
-After cloning the repository, navigate to the project directory and run:
-
-```bash
+To build and compile the typescript sources to javascript use:
+```
 npm install
 npm run build
 ```
 
 ### Publishing
 
-Once you've built the package, you can publish it to npm:
+First build the package then run `npm publish`
+
+### Consuming
+
+navigate to the folder of your consuming project and run one of the following commands.
 
-```bash
-npm publish
+_published:_
+
+```
+npm install @digital8/laravel-auth-template-ts-sdk@0.0.9 --save
 ```
 
-## License
+_unPublished (not recommended):_
 
-[]()
+```
+npm install PATH_TO_GENERATED_PACKAGE --save
+```

package/dist/models/AssetResource.d.ts

@@ -44,7 +44,7 @@ export interface AssetResource {
      * @type {string}
      * @memberof AssetResource
      */
-    altText: string;
+    altText?: string | null;
     /**
      *
      * @type {number}

package/dist/models/AssetResource.js

@@ -30,8 +30,6 @@ function instanceOfAssetResource(value) {
         return false;
     if (!('mimeType' in value) || value['mimeType'] === undefined)
         return false;
-    if (!('altText' in value) || value['altText'] === undefined)
-        return false;
     if (!('index' in value) || value['index'] === undefined)
         return false;
     if (!('fileId' in value) || value['fileId'] === undefined)
@@ -50,7 +48,7 @@ function AssetResourceFromJSONTyped(json, ignoreDiscriminator) {
         'filePath': json['filePath'],
         'fileName': json['fileName'],
         'mimeType': json['mimeType'],
-        'altText': json['altText'],
+        'altText': json['altText'] == null ? undefined : json['altText'],
         'index': json['index'],
         'fileId': json['fileId'],
     };

package/dist/models/UserResource.js

@@ -62,6 +62,7 @@ function UserResourceToJSON(json) {
     return UserResourceToJSONTyped(json, false);
 }
 function UserResourceToJSONTyped(value, ignoreDiscriminator) {
+    var _a, _b;
     if (ignoreDiscriminator === void 0) { ignoreDiscriminator = false; }
     if (value == null) {
         return value;
@@ -74,7 +75,7 @@ function UserResourceToJSONTyped(value, ignoreDiscriminator) {
         'email': value['email'],
         'mobile': value['mobile'],
         'assets': (value['assets'] == null ? null : value['assets'].map(AssetLiteResource_1.AssetLiteResourceToJSON)),
-        'createdAt': value['createdAt'] == null ? value['createdAt'] : value['createdAt'].toISOString(),
-        'updatedAt': value['updatedAt'] == null ? value['updatedAt'] : value['updatedAt'].toISOString(),
+        'createdAt': value['createdAt'] === null ? null : ((_a = value['createdAt']) === null || _a === void 0 ? void 0 : _a.toISOString()),
+        'updatedAt': value['updatedAt'] === null ? null : ((_b = value['updatedAt']) === null || _b === void 0 ? void 0 : _b.toISOString()),
     };
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@digital8/laravel-auth-template-ts-sdk",
-  "version": "0.0.8",
+  "version": "0.0.9",
   "description": "OpenAPI client for @digital8/laravel-auth-template-ts-sdk",
   "author": "OpenAPI-Generator",
   "repository": {
@@ -8,7 +8,7 @@
     "url": "https://github.com/GIT_USER_ID/GIT_REPO_ID.git"
   },
   "main": "./dist/index.js",
-  "types": "./dist/index.d.ts",
+  "typings": "./dist/index.d.ts",
   "scripts": {
     "build": "tsc",
     "prepare": "npm run build"

package/src/models/AssetResource.ts

@@ -48,7 +48,7 @@ export interface AssetResource {
      * @type {string}
      * @memberof AssetResource
      */
-    altText: string;
+    altText?: string | null;
     /**
      * 
      * @type {number}
@@ -71,7 +71,6 @@ export function instanceOfAssetResource(value: object): value is AssetResource {
     if (!('filePath' in value) || value['filePath'] === undefined) return false;
     if (!('fileName' in value) || value['fileName'] === undefined) return false;
     if (!('mimeType' in value) || value['mimeType'] === undefined) return false;
-    if (!('altText' in value) || value['altText'] === undefined) return false;
     if (!('index' in value) || value['index'] === undefined) return false;
     if (!('fileId' in value) || value['fileId'] === undefined) return false;
     return true;
@@ -91,7 +90,7 @@ export function AssetResourceFromJSONTyped(json: any, ignoreDiscriminator: boole
         'filePath': json['filePath'],
         'fileName': json['fileName'],
         'mimeType': json['mimeType'],
-        'altText': json['altText'],
+        'altText': json['altText'] == null ? undefined : json['altText'],
         'index': json['index'],
         'fileId': json['fileId'],
     };

package/src/models/UserResource.ts

@@ -137,8 +137,8 @@ export function UserResourceToJSONTyped(value?: UserResource | null, ignoreDiscr
         'email': value['email'],
         'mobile': value['mobile'],
         'assets': (value['assets'] == null ? null : (value['assets'] as Array<any>).map(AssetLiteResourceToJSON)),
-        'createdAt': value['createdAt'] == null ? value['createdAt'] : value['createdAt'].toISOString(),
-        'updatedAt': value['updatedAt'] == null ? value['updatedAt'] : value['updatedAt'].toISOString(),
+        'createdAt': value['createdAt'] === null ? null : ((value['createdAt'] as any)?.toISOString()),
+        'updatedAt': value['updatedAt'] === null ? null : ((value['updatedAt'] as any)?.toISOString()),
     };
 }
 

package/docs/AssetFileForUploadResource.md

@@ -1,40 +0,0 @@
-
-# AssetFileForUploadResource
-
-
-## Properties
-
-Name | Type
------------- | -------------
-`id` | number
-`url` | string
-`headers` | Array<string>
-`fileName` | string
-
-## Example
-
-```typescript
-import type { AssetFileForUploadResource } from '@digital8/laravel-auth-template-ts-sdk'
-
-// TODO: Update the object below with actual values
-const example = {
-  "id": null,
-  "url": null,
-  "headers": null,
-  "fileName": null,
-} satisfies AssetFileForUploadResource
-
-console.log(example)
-
-// Convert the instance to a JSON string
-const exampleJSON: string = JSON.stringify(example)
-console.log(exampleJSON)
-
-// Parse the JSON string back to an object
-const exampleParsed = JSON.parse(exampleJSON) as AssetFileForUploadResource
-console.log(exampleParsed)
-```
-
-[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
-
-

package/docs/AssetFileForUploadResourceArrayResponse.md

@@ -1,34 +0,0 @@
-
-# AssetFileForUploadResourceArrayResponse
-
-
-## Properties
-
-Name | Type
------------- | -------------
-`data` | [Array<AssetFileForUploadResource>](AssetFileForUploadResource.md)
-
-## Example
-
-```typescript
-import type { AssetFileForUploadResourceArrayResponse } from '@digital8/laravel-auth-template-ts-sdk'
-
-// TODO: Update the object below with actual values
-const example = {
-  "data": null,
-} satisfies AssetFileForUploadResourceArrayResponse
-
-console.log(example)
-
-// Convert the instance to a JSON string
-const exampleJSON: string = JSON.stringify(example)
-console.log(exampleJSON)
-
-// Parse the JSON string back to an object
-const exampleParsed = JSON.parse(exampleJSON) as AssetFileForUploadResourceArrayResponse
-console.log(exampleParsed)
-```
-
-[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
-
-

package/docs/AssetLiteResource.md

@@ -1,36 +0,0 @@
-
-# AssetLiteResource
-
-
-## Properties
-
-Name | Type
------------- | -------------
-`id` | number
-`filePath` | string
-
-## Example
-
-```typescript
-import type { AssetLiteResource } from '@digital8/laravel-auth-template-ts-sdk'
-
-// TODO: Update the object below with actual values
-const example = {
-  "id": null,
-  "filePath": null,
-} satisfies AssetLiteResource
-
-console.log(example)
-
-// Convert the instance to a JSON string
-const exampleJSON: string = JSON.stringify(example)
-console.log(exampleJSON)
-
-// Parse the JSON string back to an object
-const exampleParsed = JSON.parse(exampleJSON) as AssetLiteResource
-console.log(exampleParsed)
-```
-
-[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
-
-

package/docs/AssetLiteResourceArrayResponse.md

@@ -1,34 +0,0 @@
-
-# AssetLiteResourceArrayResponse
-
-
-## Properties
-
-Name | Type
------------- | -------------
-`data` | [Array<AssetLiteResource>](AssetLiteResource.md)
-
-## Example
-
-```typescript
-import type { AssetLiteResourceArrayResponse } from '@digital8/laravel-auth-template-ts-sdk'
-
-// TODO: Update the object below with actual values
-const example = {
-  "data": null,
-} satisfies AssetLiteResourceArrayResponse
-
-console.log(example)
-
-// Convert the instance to a JSON string
-const exampleJSON: string = JSON.stringify(example)
-console.log(exampleJSON)
-
-// Parse the JSON string back to an object
-const exampleParsed = JSON.parse(exampleJSON) as AssetLiteResourceArrayResponse
-console.log(exampleParsed)
-```
-
-[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
-
-

package/docs/AssetResource.md

@@ -1,46 +0,0 @@
-
-# AssetResource
-
-
-## Properties
-
-Name | Type
------------- | -------------
-`id` | number
-`filePath` | string
-`fileName` | string
-`mimeType` | string
-`altText` | string
-`index` | number
-`fileId` | number
-
-## Example
-
-```typescript
-import type { AssetResource } from '@digital8/laravel-auth-template-ts-sdk'
-
-// TODO: Update the object below with actual values
-const example = {
-  "id": null,
-  "filePath": null,
-  "fileName": null,
-  "mimeType": null,
-  "altText": null,
-  "index": null,
-  "fileId": null,
-} satisfies AssetResource
-
-console.log(example)
-
-// Convert the instance to a JSON string
-const exampleJSON: string = JSON.stringify(example)
-console.log(exampleJSON)
-
-// Parse the JSON string back to an object
-const exampleParsed = JSON.parse(exampleJSON) as AssetResource
-console.log(exampleParsed)
-```
-
-[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
-
-

package/docs/AssetResourceArrayResponse.md

@@ -1,34 +0,0 @@
-
-# AssetResourceArrayResponse
-
-
-## Properties
-
-Name | Type
------------- | -------------
-`data` | [Array<AssetResource>](AssetResource.md)
-
-## Example
-
-```typescript
-import type { AssetResourceArrayResponse } from '@digital8/laravel-auth-template-ts-sdk'
-
-// TODO: Update the object below with actual values
-const example = {
-  "data": null,
-} satisfies AssetResourceArrayResponse
-
-console.log(example)
-
-// Convert the instance to a JSON string
-const exampleJSON: string = JSON.stringify(example)
-console.log(exampleJSON)
-
-// Parse the JSON string back to an object
-const exampleParsed = JSON.parse(exampleJSON) as AssetResourceArrayResponse
-console.log(exampleParsed)
-```
-
-[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
-
-