agiledigital/idm-ts-types

ForgeRock IDM TypeScript Types

idm-ts-types's Issues

Port from tslint to eslint

Unit tests

idm-ts-types is starting to get to a point where it will need tests, to ensure compatibility between refactors.

It looks like it's possible to assert for typescript compile errors

The unit tests would primarily just be sample idm typescript code that use all the features of the code-gen, so we know if a feature breaks when introducing new changes.

Document global types and API wrappers

The API wrappers and global types would benefit from documentation, as it would be helpful when IDE's are doing type-ahead assistance.

We should be able to grab the documentation in the integrators guide and add it to the relevant functions.

https://backstage.forgerock.com/docs/idm/6.5/integrators-guide/#appendix-scripting

Problem with default fields when running a query

Need to fix this issue:

idm-ts-types/lib/idm-ts.ts

Lines 87 to 94 in cea1f20

	// TODO: This one doesn't work properly, it causes all type checking to disappear on fields. But not having this means, that when you don't provide
	// fields, it thinks everything is available including non-default fields
	// public query<F extends Fields<T>>(params: QueryFilter, options?: {}): QueryResult<D & Revision>;
	public query<F extends Fields<T>>(params: QueryFilter, options: { readonly fields: F[] }): QueryResult<ResultType<T, F>>;
	public query<F extends Fields<T>>(params: QueryFilter, options?: { readonly unCheckedFields?: string[] }): QueryResult<T & Revision>;
	public query<F extends Fields<T>>(params: QueryFilter, { fields, unCheckedFields }: { readonly fields?: F[]; readonly unCheckedFields?: string[] }) {
	return openidm.query(this.type, params, unCheckedFields ? unCheckedFields : fields);
	}