Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions src/@types/cedar.d.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
declare module 'cedar-artifact-viewer';
declare module 'cedar-embeddable-editor';
Original file line number Diff line number Diff line change
Expand Up @@ -54,23 +54,27 @@ <h3 class="text-lg text-red-500">{{ 'project.metadata.addMetadata.notPublishedTe
</div>
}
<div class="cedar-editor-container">
@if (readonly()) {
<cedar-artifact-viewer
#cedarViewer
[config]="cedarViewerConfig"
[templateObject]="template().attributes.template"
[instanceObject]="formData()"
></cedar-artifact-viewer>
@if (!cedarLoaded()) {
<osf-loading-spinner />
} @else {
<cedar-embeddable-editor
#cedarEditor
[config]="cedarConfig"
[templateObject]="template().attributes.template"
[metadata]="formData()"
(change)="onCedarChange($event)"
(pointerover)="validateCedarMetadata()"
(keyup)="onCedarChange($event)"
></cedar-embeddable-editor>
@if (readonly()) {
<cedar-artifact-viewer
#cedarViewer
[config]="cedarViewerConfig"
[templateObject]="template().attributes.template"
[instanceObject]="formData()"
></cedar-artifact-viewer>
} @else {
<cedar-embeddable-editor
#cedarEditor
[config]="cedarConfig"
[templateObject]="template().attributes.template"
[metadata]="formData()"
(change)="onCedarChange($event)"
(pointerover)="validateCedarMetadata()"
(keyup)="onCedarChange($event)"
></cedar-embeddable-editor>
}
}
</div>

Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,11 @@
import { MockComponent } from 'ng-mocks';

import { PLATFORM_ID } from '@angular/core';
import { ComponentFixture, TestBed } from '@angular/core/testing';

import { CedarMetadataHelper } from '@osf/features/metadata/helpers';
import { CedarMetadataDataTemplateJsonApi } from '@osf/features/metadata/models';
import { LoadingSpinnerComponent } from '@osf/shared/components/loading-spinner/loading-spinner.component';

import { CedarTemplateFormComponent } from './cedar-template-form.component';

Expand All @@ -16,7 +20,8 @@ describe('CedarTemplateFormComponent', () => {

beforeEach(async () => {
await TestBed.configureTestingModule({
imports: [CedarTemplateFormComponent, OSFTestingModule],
imports: [CedarTemplateFormComponent, OSFTestingModule, MockComponent(LoadingSpinnerComponent)],
providers: [{ provide: PLATFORM_ID, useValue: 'browser' }],
}).compileComponents();

fixture = TestBed.createComponent(CedarTemplateFormComponent);
Expand Down Expand Up @@ -75,10 +80,14 @@ describe('CedarTemplateFormComponent', () => {
expect(emitSpy).toHaveBeenCalled();
});

it('should initialize form data with empty metadata when no existing record', () => {
it('should initialize form data with empty metadata when no existing record', async () => {
fixture.componentRef.setInput('existingRecord', null);
fixture.detectChanges();

await (component as any).loadCedarLibraries();
(component as any).initializeCedar();
fixture.detectChanges();

const expectedEmptyMetadata = CedarMetadataHelper.buildEmptyMetadata();
expect(component.formData()).toEqual(expectedEmptyMetadata);
});
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ import { Tooltip } from 'primeng/tooltip';

import { map, of } from 'rxjs';

import { CommonModule } from '@angular/common';
import { CommonModule, isPlatformBrowser } from '@angular/common';
import {
ChangeDetectionStrategy,
Component,
Expand All @@ -16,6 +16,7 @@ import {
inject,
input,
output,
PLATFORM_ID,
signal,
viewChild,
ViewEncapsulation,
Expand All @@ -24,9 +25,7 @@ import { toSignal } from '@angular/core/rxjs-interop';
import { ActivatedRoute } from '@angular/router';

import { ENVIRONMENT } from '@core/provider/environment.provider';

import 'cedar-artifact-viewer';
import 'cedar-embeddable-editor';
import { LoadingSpinnerComponent } from '@osf/shared/components/loading-spinner/loading-spinner.component';

import { CEDAR_CONFIG, CEDAR_VIEWER_CONFIG } from '../../constants';
import { CedarMetadataHelper } from '../../helpers';
Expand All @@ -39,7 +38,7 @@ import {

@Component({
selector: 'osf-cedar-template-form',
imports: [CommonModule, Button, TranslatePipe, Tooltip, Menu],
imports: [CommonModule, Button, TranslatePipe, Tooltip, Menu, LoadingSpinnerComponent],
templateUrl: './cedar-template-form.component.html',
styleUrl: './cedar-template-form.component.scss',
schemas: [CUSTOM_ELEMENTS_SCHEMA],
Expand All @@ -66,11 +65,15 @@ export class CedarTemplateFormComponent {

private route = inject(ActivatedRoute);
readonly environment = inject(ENVIRONMENT);
private platformId = inject(PLATFORM_ID);
readonly cedarLoaded = signal<boolean>(false);

readonly recordId = signal<string>('');
readonly downloadUrl = signal<string>('');
readonly schemaName = signal<string>('');

readonly fileGuid = toSignal(this.route.params.pipe(map((params) => params['fileGuid'])) ?? of(undefined));

shareItems = [
{
label: 'files.detail.actions.share.email',
Expand All @@ -90,15 +93,15 @@ export class CedarTemplateFormComponent {
effect(() => {
const tpl = this.template();
if (tpl?.attributes?.template) {
this.initializeCedar();
this.loadCedarLibraries().then(() => this.initializeCedar());
}
});

effect(() => {
const record = this.existingRecord();
this.schemaName.set(record?.embeds?.template.data.attributes.schema_name || '');
if (record) {
this.initializeCedar();
this.loadCedarLibraries().then(() => this.initializeCedar());
}
});
}
Expand All @@ -123,7 +126,30 @@ export class CedarTemplateFormComponent {
this.validateCedarMetadata();
}

readonly fileGuid = toSignal(this.route.params.pipe(map((params) => params['fileGuid'])) ?? of(undefined));
private initializeFormData(): void {
const template = this.template()?.attributes?.template;
if (!template) return;
const metadata = this.existingRecord()?.attributes?.metadata;
if (this.existingRecord()) {
const structuredMetadata = CedarMetadataHelper.buildStructuredMetadata(metadata);
this.formData.set(structuredMetadata);
} else {
this.formData.set(CedarMetadataHelper.buildEmptyMetadata());
}
}

private async loadCedarLibraries(): Promise<void> {
if (!isPlatformBrowser(this.platformId) || this.cedarLoaded()) {
return;
}

try {
await Promise.all([import('cedar-artifact-viewer'), import('cedar-embeddable-editor')]);
this.cedarLoaded.set(true);
} catch {
this.cedarLoaded.set(false);
}
}

downloadMetadadaRecord() {
if (this.fileGuid()) {
Expand Down Expand Up @@ -173,19 +199,6 @@ export class CedarTemplateFormComponent {
this.emitData.emit(finalData as CedarRecordDataBinding);
}
}

private initializeFormData(): void {
const template = this.template()?.attributes?.template;
if (!template) return;
const metadata = this.existingRecord()?.attributes?.metadata;
if (this.existingRecord()) {
const structuredMetadata = CedarMetadataHelper.buildStructuredMetadata(metadata);
this.formData.set(structuredMetadata);
} else {
this.formData.set(CedarMetadataHelper.buildEmptyMetadata());
}
}

handleEmailShare(): void {
const url = window.location.href;
window.location.href = `mailto:?subject=${this.schemaName()}&body=${url}`;
Expand Down