@resistdesign/voltra 0.0.0-alpha.0

package/src/index.d.ts

@@ -0,0 +1,178 @@
+/**
+ * Route RPC back-end API requests to the appropriate functions with context about authentication, the request itself and more.
+ *
+ * @usage `import * from "@resistdesign/voltra/api";`
+ *
+ * @example
+ * ```typescript
+ * export const handler = async (event: any): Promise<CloudFunctionResponse> =>
+ *   handleCloudFunctionEvent(
+ *     event,
+ *     AWS.normalizeCloudFunctionEvent,
+ *     addRoutesToRouteMap({}, [
+ *       {
+ *         path: "",
+ *         authConfig: {
+ *           anyAuthorized: true,
+ *         },
+ *         handler: async () => 'WELCOME!!!!',
+ *       }
+ *     ]),
+ *     [
+ *       process.env.CLIENT_ORIGIN as string,
+ *       /https:\\/\\/example\\.com(:.*?$|\\/.*$|$)/gim,
+ *     ]
+ *   );
+ * ```
+ * */
+export * as API from "./api";
+/**
+ * Build front-end applications with React/TypeScript, layout systems, form generation, RPC requests, easy state management and more.
+ *
+ * @usage `import * from "@resistdesign/voltra/app";`
+ *
+ * @see {@link getEasyLayout}, {@link TypeInfoApplication} and {@link useApplicationStateLoader} for some great starting points.
+ *
+ * @example
+ * ```tsx
+ * const APP_STATE_IDENTIFIERS = {
+ *   LOGIN: {
+ *     USERNAME: {},
+ *     PASSWORD: {},
+ *     LOGGED_IN: {},
+ *   },
+ * };
+ *
+ * const LOGIN_SERVICE_CONFIG = {
+ *   protocol: "https",
+ *   domain: "example.com",
+ *   basePath: "/api",
+ * };
+ * const LOGIN_RPC: RemoteProcedureCall = {
+ *   serviceConfig: LOGIN_SERVICE_CONFIG,
+ *   path: "/login",
+ *   args: [],
+ * };
+ *
+ * const {
+ *   layout: LoginLayout,
+ *   areas: { Header, Side, Main },
+ * } = getEasyLayout()`
+ *   header header, 1fr
+ *   side main, 3fr
+ *   // 1fr 3fr
+ * `;
+ *
+ * export const Login: FC = () => {
+ *   const {
+ *     valueStructure: {
+ *       username: username = "",
+ *       password: password = "",
+ *       loggedIn: loggedIn = false,
+ *     },
+ *     onChangeStructure: {
+ *       username: setUsername,
+ *       password: setPassword,
+ *       loggedIn: setLoggedIn,
+ *     },
+ *   } = useApplicationStateValueStructure<{
+ *     username: string;
+ *     password: string;
+ *     loggedIn: boolean;
+ *   }>({
+ *     username: APP_STATE_IDENTIFIERS.LOGIN.USERNAME,
+ *     password: APP_STATE_IDENTIFIERS.LOGIN.PASSWORD,
+ *     loggedIn: APP_STATE_IDENTIFIERS.LOGIN.LOGGED_IN,
+ *   });
+ *   const onUsernameChange = useCallback(
+ *     (event: ReactChangeEvent<HTMLInputElement>) => {
+ *       setUsername(event.target.value);
+ *     },
+ *     [setUsername],
+ *   );
+ *   const onPasswordChange = useCallback(
+ *     (event: ReactChangeEvent<HTMLInputElement>) => {
+ *       setPassword(event.target.value);
+ *     },
+ *     [setPassword],
+ *   );
+ *   const { loading: loadingLogin, makeRemoteProcedureCall } =
+ *     useApplicationStateLoader({
+ *       identifier: APP_STATE_IDENTIFIERS.LOGIN.LOGGED_IN,
+ *       remoteProcedureCall: LOGIN_RPC,
+ *       manual: true,
+ *     });
+ *   const onSubmit = useCallback(() => {
+ *     makeRemoteProcedureCall(username, password);
+ *   }, [username, password, makeRemoteProcedureCall]);
+ *
+ *   return (
+ *     <LoginLayout>
+ *       <Header>
+ *         <h1>Login</h1>
+ *       </Header>
+ *       <Side>
+ *         <h5>Login here:</h5>
+ *       </Side>
+ *       <Main>
+ *         {loadingLogin ? (
+ *           <>Loading...</>
+ *         ) : loggedIn ? (
+ *           <>Logged In!</>
+ *         ) : (
+ *           <BaseForm onSubmit={onSubmit}>
+ *             <input
+ *               type="text"
+ *               placeholder="Username"
+ *               value={username}
+ *               onChange={onUsernameChange}
+ *             />
+ *             <br />
+ *             <input
+ *               type="password"
+ *               placeholder="Password"
+ *               value={password}
+ *               onChange={onPasswordChange}
+ *             />
+ *             <br />
+ *             <br />
+ *             <button type="submit">Log In</button>
+ *           </BaseForm>
+ *         )}
+ *       </Main>
+ *     </LoginLayout>
+ *   );
+ * };
+ * ```
+ * */
+export * as App from "./app";
+/**
+ * Build infrastructure as code with reusable components and utilities.
+ *
+ * @usage Start with `SimpleCFT`, add packs and use utilities as needed.
+ *
+ * `import * from "@resistdesign/voltra/iac";`
+ *
+ * @example
+ * ```typescript
+ * const ctf = new SimpleCFT()
+ *   .applyPack(
+ *     addDNS,
+ *     {
+ *       hostedZoneIdParameterName: "<YOUR_INFO_HERE>",
+ *       domainNameParameterName: "<YOUR_INFO_HERE>",
+ *       localUIDevelopmentDomainName: "<YOUR_INFO_HERE>",
+ *       localUIDevelopmentIPAddress: "<YOUR_INFO_HERE>",
+ *     }
+ *   );
+ *
+ * console.log(cft.template);
+ *  ```
+ * */
+export * as IaC from "./iac";
+/**
+ * A set of common utilities for use in all layers of the application stack.
+ *
+ * @usage `import * from "@resistdesign/voltra/common";`
+ * */
+export * as Common from "./common";

package/src/index.js

@@ -0,0 +1,214 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Common = exports.IaC = exports.App = exports.API = void 0;
+/**
+ * Route RPC back-end API requests to the appropriate functions with context about authentication, the request itself and more.
+ *
+ * @usage `import * from "@resistdesign/voltra/api";`
+ *
+ * @example
+ * ```typescript
+ * export const handler = async (event: any): Promise<CloudFunctionResponse> =>
+ *   handleCloudFunctionEvent(
+ *     event,
+ *     AWS.normalizeCloudFunctionEvent,
+ *     addRoutesToRouteMap({}, [
+ *       {
+ *         path: "",
+ *         authConfig: {
+ *           anyAuthorized: true,
+ *         },
+ *         handler: async () => 'WELCOME!!!!',
+ *       }
+ *     ]),
+ *     [
+ *       process.env.CLIENT_ORIGIN as string,
+ *       /https:\\/\\/example\\.com(:.*?$|\\/.*$|$)/gim,
+ *     ]
+ *   );
+ * ```
+ * */
+exports.API = __importStar(require("./api"));
+/**
+ * Build front-end applications with React/TypeScript, layout systems, form generation, RPC requests, easy state management and more.
+ *
+ * @usage `import * from "@resistdesign/voltra/app";`
+ *
+ * @see {@link getEasyLayout}, {@link TypeInfoApplication} and {@link useApplicationStateLoader} for some great starting points.
+ *
+ * @example
+ * ```tsx
+ * const APP_STATE_IDENTIFIERS = {
+ *   LOGIN: {
+ *     USERNAME: {},
+ *     PASSWORD: {},
+ *     LOGGED_IN: {},
+ *   },
+ * };
+ *
+ * const LOGIN_SERVICE_CONFIG = {
+ *   protocol: "https",
+ *   domain: "example.com",
+ *   basePath: "/api",
+ * };
+ * const LOGIN_RPC: RemoteProcedureCall = {
+ *   serviceConfig: LOGIN_SERVICE_CONFIG,
+ *   path: "/login",
+ *   args: [],
+ * };
+ *
+ * const {
+ *   layout: LoginLayout,
+ *   areas: { Header, Side, Main },
+ * } = getEasyLayout()`
+ *   header header, 1fr
+ *   side main, 3fr
+ *   // 1fr 3fr
+ * `;
+ *
+ * export const Login: FC = () => {
+ *   const {
+ *     valueStructure: {
+ *       username: username = "",
+ *       password: password = "",
+ *       loggedIn: loggedIn = false,
+ *     },
+ *     onChangeStructure: {
+ *       username: setUsername,
+ *       password: setPassword,
+ *       loggedIn: setLoggedIn,
+ *     },
+ *   } = useApplicationStateValueStructure<{
+ *     username: string;
+ *     password: string;
+ *     loggedIn: boolean;
+ *   }>({
+ *     username: APP_STATE_IDENTIFIERS.LOGIN.USERNAME,
+ *     password: APP_STATE_IDENTIFIERS.LOGIN.PASSWORD,
+ *     loggedIn: APP_STATE_IDENTIFIERS.LOGIN.LOGGED_IN,
+ *   });
+ *   const onUsernameChange = useCallback(
+ *     (event: ReactChangeEvent<HTMLInputElement>) => {
+ *       setUsername(event.target.value);
+ *     },
+ *     [setUsername],
+ *   );
+ *   const onPasswordChange = useCallback(
+ *     (event: ReactChangeEvent<HTMLInputElement>) => {
+ *       setPassword(event.target.value);
+ *     },
+ *     [setPassword],
+ *   );
+ *   const { loading: loadingLogin, makeRemoteProcedureCall } =
+ *     useApplicationStateLoader({
+ *       identifier: APP_STATE_IDENTIFIERS.LOGIN.LOGGED_IN,
+ *       remoteProcedureCall: LOGIN_RPC,
+ *       manual: true,
+ *     });
+ *   const onSubmit = useCallback(() => {
+ *     makeRemoteProcedureCall(username, password);
+ *   }, [username, password, makeRemoteProcedureCall]);
+ *
+ *   return (
+ *     <LoginLayout>
+ *       <Header>
+ *         <h1>Login</h1>
+ *       </Header>
+ *       <Side>
+ *         <h5>Login here:</h5>
+ *       </Side>
+ *       <Main>
+ *         {loadingLogin ? (
+ *           <>Loading...</>
+ *         ) : loggedIn ? (
+ *           <>Logged In!</>
+ *         ) : (
+ *           <BaseForm onSubmit={onSubmit}>
+ *             <input
+ *               type="text"
+ *               placeholder="Username"
+ *               value={username}
+ *               onChange={onUsernameChange}
+ *             />
+ *             <br />
+ *             <input
+ *               type="password"
+ *               placeholder="Password"
+ *               value={password}
+ *               onChange={onPasswordChange}
+ *             />
+ *             <br />
+ *             <br />
+ *             <button type="submit">Log In</button>
+ *           </BaseForm>
+ *         )}
+ *       </Main>
+ *     </LoginLayout>
+ *   );
+ * };
+ * ```
+ * */
+exports.App = __importStar(require("./app"));
+/**
+ * Build infrastructure as code with reusable components and utilities.
+ *
+ * @usage Start with `SimpleCFT`, add packs and use utilities as needed.
+ *
+ * `import * from "@resistdesign/voltra/iac";`
+ *
+ * @example
+ * ```typescript
+ * const ctf = new SimpleCFT()
+ *   .applyPack(
+ *     addDNS,
+ *     {
+ *       hostedZoneIdParameterName: "<YOUR_INFO_HERE>",
+ *       domainNameParameterName: "<YOUR_INFO_HERE>",
+ *       localUIDevelopmentDomainName: "<YOUR_INFO_HERE>",
+ *       localUIDevelopmentIPAddress: "<YOUR_INFO_HERE>",
+ *     }
+ *   );
+ *
+ * console.log(cft.template);
+ *  ```
+ * */
+exports.IaC = __importStar(require("./iac"));
+/**
+ * A set of common utilities for use in all layers of the application stack.
+ *
+ * @usage `import * from "@resistdesign/voltra/common";`
+ * */
+exports.Common = __importStar(require("./common"));