@jd-data-limited/easy-fm 4.1.5 → 4.1.8

package/src/bin/cli.js

@@ -1,17 +0,0 @@
-#!/usr/bin/env node
-/*
- * Copyright (c) 2024. See LICENSE file for more information
- */
-import { Command } from "commander";
-import { generateTypesCLI } from "./generateTypes.js";
-const program = new Command();
-program
-    .name("easyfm")
-    .description("A NodeJS wrapper for the FileMaker Data CLI");
-program
-    .command("generate-types")
-    .description("Automatically generate layout interfaces from your database")
-    .action(() => {
-    generateTypesCLI();
-});
-program.parse(process.argv);

package/src/bin/cli.ts

@@ -1,22 +0,0 @@
-#!/usr/bin/env node
-/*
- * Copyright (c) 2024. See LICENSE file for more information
- */
-
-import {Command} from "commander"
-import {generateTypesCLI} from "./generateTypes.js";
-
-const program = new Command()
-
-program
-    .name("easyfm")
-    .description("A NodeJS wrapper for the FileMaker Data CLI")
-
-program
-    .command("generate-types")
-    .description("Automatically generate layout interfaces from your database")
-    .action(() => {
-        generateTypesCLI()
-    })
-
-program.parse(process.argv)

package/src/bin/generateTypes.d.ts

@@ -1 +0,0 @@
-export declare function generateTypesCLI(): Promise<void>;

package/src/bin/generateTypes.js

@@ -1,161 +0,0 @@
-/*
- * Copyright (c) 2024. See LICENSE file for more information
- */
-import { ApiFieldResultTypes } from "../models/apiResults.js";
-import inquirer from 'inquirer';
-import FMHost from "../connection/FMHost.js";
-import * as fs from "fs";
-function sub(str) {
-    return str
-        .replace(/[^a-zA-Z0-9_]/g, "") // Remove non-alphanumeric characters
-        .replace(/^[0-9]+/g, ''); // Removing leading numbers
-}
-function generateFieldType(field) {
-    switch (field.result) {
-        case ApiFieldResultTypes.TEXT:
-            return "Field<string>";
-        case ApiFieldResultTypes.CONTAINER:
-            return "Field<Container>";
-        case ApiFieldResultTypes.DATE:
-            return "Field<Date>";
-        case ApiFieldResultTypes.NUMBER:
-            return "Field<number>";
-        case ApiFieldResultTypes.TIME:
-            return "Field<Date>";
-        case ApiFieldResultTypes.TIMESTAMP:
-            return "Field<Date>";
-    }
-}
-function processFieldsChunk(fields) {
-    let existing_fields = [];
-    fields = fields.filter(field => {
-        if (existing_fields.includes(field.name))
-            return false;
-        existing_fields.push(field.name);
-        return true;
-    });
-    return fields.map(field => {
-        return JSON.stringify(field.name) + ": " + generateFieldType(field);
-    });
-}
-function camelToSnakeCase(str) {
-    return str.replace(/([a-z0-9])([A-Z])/g, '$1_$2').toLowerCase();
-}
-function safeStringInjection(str, ...args) {
-    let result = "";
-    for (let i = 0; i < str.length; i++) {
-        result += str[i];
-        if (i < args.length) {
-            result += JSON.stringify(args[i].toString());
-        }
-    }
-    return result;
-}
-export async function generateTypesCLI() {
-    process.stdout.write('\x1Bc');
-    console.log("For this tool to work, you are required to have access to an account on the target database.\n" +
-        "This account must have the fmrest extended privilege enabled.\n" +
-        "This tool can only export type interfaces for layouts that the given account has access to.");
-    console.log("\n");
-    const data = await inquirer.prompt([
-        {
-            type: "input",
-            name: "hostname",
-            message: "The IP address/domain of your FileMaker server (must start with either http:// or https://)",
-            validate(input) {
-                return input.startsWith("http://") || input.startsWith("https://") || "Please enter a valid IP address/domain starting with http:// or https://";
-            }
-        },
-        {
-            type: "number",
-            name: "timezoneOffset",
-            message: "Server timezone offset (minutes)",
-            default: 0 - (new Date()).getTimezoneOffset()
-        },
-        {
-            type: "confirm",
-            name: "verify",
-            default: true,
-            message: "Verify your server's identity",
-            when(previousAnswers) {
-                return previousAnswers.hostname.startsWith("https://");
-            }
-        },
-        {
-            type: "input",
-            name: "database",
-            message: "Database filename"
-        },
-        {
-            type: "input",
-            name: "username",
-            message: "Database username"
-        },
-        {
-            type: "password",
-            name: "password",
-            message: "Database password",
-            mask: "*"
-        }
-    ]);
-    const HOST = new FMHost(data.hostname, data.timezoneOffset, data.verify);
-    const DATABASE = HOST.database({
-        database: data.database,
-        credentials: {
-            method: "filemaker",
-            username: data.username,
-            password: data.password
-        },
-        externalSources: []
-    });
-    await DATABASE.login();
-    // Create file write stream
-    const stream = fs.createWriteStream("./types.ts");
-    let layouts = await DATABASE.listLayouts();
-    stream.write(`import FMHost, {Container, FieldBase, LayoutInterface, Portal} from "@jd-data-limited/easy-fm";\n`);
-    stream.write("// " + layouts.length + " layouts found\n\n");
-    let layoutInterfaces = new Map();
-    for (let layout of layouts) {
-        let substituteName = sub(layout.name);
-        if (!substituteName)
-            continue;
-        console.log(substituteName);
-        let metadata = await layout.getLayoutMeta();
-        let fields = processFieldsChunk(metadata.fieldMetaData);
-        let portals = metadata.portalMetaData;
-        let portalsProcessed = Object.keys(portals).map(portalName => {
-            return `${JSON.stringify(portalName)}: Portal<{${processFieldsChunk(portals[portalName])}}>`;
-        });
-        let interfaceName = substituteName + "LayoutInterface";
-        layoutInterfaces.set(layout.name, {
-            interfaceName,
-            interface: `export interface ${interfaceName} extends LayoutInterface {
-            fields: {${fields.join(",\n    ")}},
-            portals: {${portalsProcessed.join(",\n   ")}}
-        }`
-        });
-    }
-    let layoutInterfaceLinks = [];
-    for (let layout of layoutInterfaces) {
-        layoutInterfaceLinks.push([
-            `${JSON.stringify(layout[0])}: ${layout[1].interfaceName}`,
-            `${sub(camelToSnakeCase(layout[0]).toUpperCase().replace(" ", "_"))}: HOST.getLayout<${layout[1].interfaceName}>(${JSON.stringify(layout[0])})`
-        ]);
-    }
-    stream.write(safeStringInjection `const HOST = new FMHost(${data.hostname}, ${data.timezoneOffset}, ${data.verify});`);
-    stream.write(`HOST.database<{layouts:{${layoutInterfaceLinks.map(i => i[0]).join(",")}}}>();`);
-    stream.write("\n\n");
-    stream.write(`const LAYOUTS = {${layoutInterfaceLinks.map(i => i[1]).join(",")}};`);
-    for (let layout of layoutInterfaces) {
-        stream.write("\n\n");
-        stream.write(layout[1].interface + ";");
-    }
-    // StructureKind
-    //
-    // const project = new Project({
-    //     tsConfigFilePath: "../tsconfig.json"
-    // })
-    // project.resolveSourceFileDependencies()
-    await DATABASE.logout();
-    console.log("DONE! Wrote database types to ./types.ts");
-}

package/src/bin/generateTypes.ts

@@ -1,189 +0,0 @@
-/*
- * Copyright (c) 2024. See LICENSE file for more information
- */
-
-import {ApiFieldMetadata, ApiFieldResultTypes} from "../models/apiResults.js";
-import inquirer from 'inquirer';
-import FMHost from "../connection/FMHost.js";
-import * as fs from "fs";
-
-function sub(str: string) {
-    return str
-        .replace(/[^a-zA-Z0-9_]/g, "") // Remove non-alphanumeric characters
-        .replace(/^[0-9]+/g, '') // Removing leading numbers
-}
-
-function generateFieldType(field: ApiFieldMetadata) {
-    switch (field.result) {
-        case ApiFieldResultTypes.TEXT:
-            return "Field<string>"
-        case ApiFieldResultTypes.CONTAINER:
-            return "Field<Container>"
-        case ApiFieldResultTypes.DATE:
-            return "Field<Date>"
-        case ApiFieldResultTypes.NUMBER:
-            return "Field<number>"
-        case ApiFieldResultTypes.TIME:
-            return "Field<Date>"
-        case ApiFieldResultTypes.TIMESTAMP:
-            return "Field<Date>"
-    }
-}
-
-function processFieldsChunk(fields: ApiFieldMetadata[]) {
-    let existing_fields: string[] = []
-    fields = fields.filter(field => {
-        if (existing_fields.includes(field.name)) return false
-        existing_fields.push(field.name)
-        return true
-    })
-
-    return fields.map(field => {
-        return JSON.stringify(field.name) + ": " + generateFieldType(field)
-    })
-}
-
-function camelToSnakeCase(str: string) {
-    return str.replace(/([a-z0-9])([A-Z])/g, '$1_$2').toLowerCase();
-}
-
-function safeStringInjection(str: TemplateStringsArray, ...args: {toString(): string}[]) {
-    let result = "";
-    for (let i = 0; i < str.length; i++) {
-        result += str[i];
-        if (i < args.length) {
-            result += JSON.stringify(args[i].toString());
-        }
-    }
-    return result;
-}
-
-export async function generateTypesCLI() {
-    process.stdout.write('\x1Bc');
-    console.log("For this tool to work, you are required to have access to an account on the target database.\n" +
-        "This account must have the fmrest extended privilege enabled.\n" +
-        "This tool can only export type interfaces for layouts that the given account has access to.")
-    console.log("\n")
-
-    const data = await inquirer.prompt([
-        {
-            type: "input",
-            name: "hostname",
-            message: "The IP address/domain of your FileMaker server (must start with either http:// or https://)",
-            validate(input: any): boolean | string | Promise<boolean | string> {
-                return input.startsWith("http://") || input.startsWith("https://") || "Please enter a valid IP address/domain starting with http:// or https://";
-            }
-        },
-        {
-            type: "number",
-            name: "timezoneOffset",
-            message: "Server timezone offset (minutes)",
-            default: 0 - (new Date()).getTimezoneOffset()
-        },
-        {
-            type: "confirm",
-            name: "verify",
-            default: true,
-            message: "Verify your server's identity",
-            when(previousAnswers) {
-                return previousAnswers.hostname.startsWith("https://")
-            }
-        },
-        {
-            type: "input",
-            name: "database",
-            message: "Database filename"
-        },
-        {
-            type: "input",
-            name: "username",
-            message: "Database username"
-        },
-        {
-            type: "password",
-            name: "password",
-            message: "Database password",
-            mask: "*"
-        }
-    ])
-
-    const HOST = new FMHost(data.hostname, data.timezoneOffset, data.verify)
-    const DATABASE = HOST.database({
-        database: data.database,
-        credentials: {
-            method: "filemaker",
-            username: data.username,
-            password: data.password
-        },
-        externalSources: []
-    })
-
-    await DATABASE.login()
-    // Create file write stream
-    const stream = fs.createWriteStream("./types.ts")
-    let layouts = await DATABASE.listLayouts()
-
-    stream.write(`import FMHost, {Container, FieldBase, LayoutInterface, Portal} from "@jd-data-limited/easy-fm";\n`)
-    stream.write("// " + layouts.length + " layouts found\n\n")
-
-    let layoutInterfaces = new Map<string, {
-        interfaceName: string,
-        interface: string
-    }>()
-    for (let layout of layouts) {
-        let substituteName = sub(layout.name)
-        if (!substituteName) continue
-        console.log(substituteName)
-        let metadata = await layout.getLayoutMeta()
-        let fields = processFieldsChunk(metadata.fieldMetaData)
-
-        let portals = metadata.portalMetaData
-        let portalsProcessed = Object.keys(portals).map(portalName => {
-            return `${JSON.stringify(portalName)}: Portal<{${processFieldsChunk(
-                portals[portalName]
-            )}}>`
-        })
-
-        let interfaceName = substituteName + "LayoutInterface"
-        layoutInterfaces.set(layout.name, {
-            interfaceName,
-            interface: `export interface ${interfaceName} extends LayoutInterface {
-            fields: {${fields.join(",\n    ")}},
-            portals: {${portalsProcessed.join(",\n   ")}}
-        }`
-        })
-    }
-
-    let layoutInterfaceLinks: [string, string][] = []
-    for (let layout of layoutInterfaces) {
-        layoutInterfaceLinks.push([
-            `${JSON.stringify(layout[0])}: ${layout[1].interfaceName}`,
-            `${sub(camelToSnakeCase(layout[0]).toUpperCase().replace(" ", "_"))}: HOST.getLayout<${layout[1].interfaceName}>(${JSON.stringify(layout[0])})`
-        ])
-    }
-
-    stream.write(safeStringInjection`const HOST = new FMHost(${data.hostname}, ${data.timezoneOffset}, ${data.verify});`)
-    stream.write(`HOST.database<{layouts:{${
-        layoutInterfaceLinks.map(i => i[0]).join(",")
-    }}}>();`)
-
-    stream.write("\n\n")
-    stream.write(`const LAYOUTS = {${
-        layoutInterfaceLinks.map(i => i[1]).join(",")
-    }};`)
-
-    for (let layout of layoutInterfaces) {
-        stream.write("\n\n")
-        stream.write(layout[1].interface + ";")
-    }
-
-    // StructureKind
-    //
-    // const project = new Project({
-    //     tsConfigFilePath: "../tsconfig.json"
-    // })
-    // project.resolveSourceFileDependencies()
-
-    await DATABASE.logout()
-    console.log("DONE! Wrote database types to ./types.ts")
-}

package/src/connection/FMHost.ts

@@ -1,123 +0,0 @@
-/*
- * Copyright (c) 2023-2024. See LICENSE file for more information
- */
-
-import {generateAuthorizationHeaders} from './generateAuthorizationHeaders.js'
-import {FMError} from '../FMError.js'
-import {Database} from './database.js'
-import {type HostBase} from './HostBase.js'
-import {
-    type databaseOptionsWithExternalSources,
-    type FMHostMetadata,
-    type loginOptionsClaris,
-    type loginOptionsFileMaker,
-    type loginOptionsOAuth
-} from '../types.js'
-import {type ApiResults} from '../models/apiResults.js'
-import {type DatabaseStructure} from '../databaseStructure.js'
-import {type Moment} from 'moment'
-
-/**
- * Represents a FileMaker host.
- * @implements {HostBase}
- */
-export default class FMHost implements HostBase {
-    readonly hostname: string
-    readonly timezoneOffsetFunc: (moment: Moment) => number
-    readonly verify: boolean
-    readonly protocol: 'http:' | 'https:'
-    _metadata: FMHostMetadata | null = null
-
-    constructor (
-        _hostname: string,
-        timezoneOffset = (moment: Moment) => 0 - (new Date()).getTimezoneOffset(),
-        verify = true
-    ) {
-        if (!(/^https?:\/\//).test(_hostname)) throw new Error('hostname MUST begin with either http:// or https://')
-        this.protocol = _hostname.startsWith('https:') ? 'https:' : 'http:'
-        this.hostname = _hostname.split('//')[1]
-        this.timezoneOffsetFunc = timezoneOffset
-        this.verify = verify
-    }
-
-    get metadata (): FMHostMetadata {
-        return this._metadata ?? {
-            productInfo: {
-                buildDate: new Date(),
-                name: '',
-                version: '',
-                dateFormat: 'MM/dd/yyyy',
-                timeFormat: 'HH:mm:ss',
-                timeStampFormat: 'MM/dd/yyyy HH:mm:ss'
-            }
-        }
-    }
-
-    get dateFormat () {
-        return this.metadata.productInfo.dateFormat
-            .replace('dd', 'DD')
-            .replace('yyyy', 'YYYY')
-    }
-
-    get timeFormat () { return this.metadata.productInfo.timeFormat }
-    get timeStampFormat () {
-        return this.metadata.productInfo.timeStampFormat
-            .replace('dd', 'DD')
-            .replace('yyyy', 'YYYY')
-    }
-
-    /**
-     * Retrieves a list of databases from the FileMaker Server.
-     *
-     * @param {loginOptionsOAuth | loginOptionsFileMaker | loginOptionsClaris} [credentials] - Optional credentials required for authentication.
-     * @throws {FMError} If the request to the FileMaker Server fails or if the response contains an error.
-     * @returns {Promise<any[]>} A promise that resolves to an array of database objects if successful.
-     */
-    async listDatabases (credentials?: loginOptionsOAuth | loginOptionsFileMaker | loginOptionsClaris) {
-        let headers = {}
-        if (credentials) {
-            headers = generateAuthorizationHeaders(credentials)
-        }
-
-        const _fetch = await fetch(`${this.hostname}/fmi/data/v2/databases`, {
-            method: 'GET',
-            headers
-        })
-        const data = await _fetch.json() as ApiResults<{ databases: any }>
-        // console.log(data.messages[0])
-
-        if (data.messages[0].code === '0' && data.response) {
-            return data.response.databases
-        } else {
-            throw new FMError(data.messages[0].code, _fetch.status, data)
-        }
-    }
-
-    /**
-     * Creates a new database connection with the specified options.
-     *
-     * @template T - The type of the database structure.
-     * @param {databaseOptionsWithExternalSources} data - The options for the database, including external sources.
-     * @return {Database<T>} A new Database instance.
-     */
-    database<T extends DatabaseStructure>(data: databaseOptionsWithExternalSources) {
-        return new Database<T>(this, data)
-    }
-
-    async getMetadata () {
-        if (this._metadata) return this._metadata
-
-        const _fetch = await fetch(`${this.protocol}//${this.hostname}/fmi/data/v2/productInfo`, {
-            method: 'GET'
-        })
-        const data = await _fetch.json() as ApiResults<FMHostMetadata>
-        // console.log(data.messages[0])
-
-        if (data.messages[0].code === '0' && data.response) {
-            this._metadata = data.response
-            return data.response
-        } else {
-            throw new FMError(data.messages[0].code, _fetch.status, data)
-        }
-    }
-}

package/src/connection/HostBase.ts

@@ -1,18 +0,0 @@
-/*
- * Copyright (c) 2023-2024. See LICENSE file for more information
- */
-
-import {type FMHostMetadata} from '../types.js'
-import {type Moment} from 'moment'
-
-export interface HostBase {
-    readonly hostname: string
-    readonly protocol: string
-    readonly timezoneOffsetFunc: (moment: Moment) => number
-    readonly verify: boolean
-    metadata: FMHostMetadata
-    getMetadata: () => PromiseLike<any>
-    timeFormat: string
-    dateFormat: string
-    timeStampFormat: string
-}