Proposed v1.0.0 of Schema Codegen

[dawsontoth]

This PR mostly adds the workflows that we'll want, but it also formatted the code that I put together. Review whatever you feel like reviewing! Or just try it out on your project.

During dev, you'll want to git clone this repo, cd into it, and then (npm link && cd ~/path-to-your-app && npm link @harperfast/schema-codegen).

Then configure this in your app's config.yaml:

config.yaml:

'@harperfast/schema-codegen':
  package: '@harperfast/schema-codegen'
  globalTypes: 'schemas/globalTypes.d.ts'
  schemaTypes: 'schemas/types.ts'

and when you harper dev ., it will generate stuff in those two files for you:

globalTypes.d.ts:

/**
 Generated from your schema files
 Manual changes will be lost!
 > harper dev .
 */
import type { Table } from 'harperdb';
import type { Device, other_Device } from './types.ts';

declare module 'harperdb' {
	export const tables: {
		Devices: { new(...args: any[]): Table<Device> };
	};

	export const databases: {
		data: {
			Devices: { new(...args: any[]): Table<Device> };
		};
		other: {
			Devices: { new(...args: any[]): Table<other_Device> };
		};
	};
}

types.ts:

/**
 Generated from HarperDB schema
 Manual changes will be lost!
 > harper dev .
 */
export interface Device {
	id: string;
	userId: string;
	name?: string;
	lastActive?: number;
	status?: string;
	command?: string;
	commandTimestamp?: number;
	commandArgument?: any;
	lastActionByHuman?: number;
	instigatorDeviceId?: string;
}

export type NewDevice = Omit<Device, 'id'>;
export type Devices = Device[];
export type { Device as DeviceRecord };
export type DeviceRecords = Device[];
export type NewDeviceRecord = Omit<Device, 'id'>;

export interface other_Device {
	id: any;
	__createdtime__?: any;
	__updatedtime__?: any;
}

export type other_NewDevice = Omit<other_Device, 'id'>;
export type other_Devices = other_Device[];
export type { other_Device as other_DeviceRecord };
export type other_DeviceRecords = other_Device[];
export type other_NewDeviceRecord = Omit<other_Device, 'id'>;

[dawsontoth]

@cb1kenobi addressed everything!

[cb1kenobi]

In case you're curious, here's rocksdb-js' oxfmt config: https://github.com/HarperFast/rocksdb-js/blob/main/.oxfmtrc.json. Most of the settings are the defaults and could have been omitted.

[dawsontoth]

I think I've got it down to the minimum in this repo -- are there other ones that you think should be the norm for Harper? Single quotes and tabs.

{
	"$schema": "./node_modules/oxfmt/configuration_schema.json",
	"singleQuote": true,
	"useTabs": true
}

[dawsontoth]

In theory, I'll start applying this consistently across other repos I touch like Studio, Agent and create harper.

[cb1kenobi]

LGTM!